Commit 702ca026 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Mark Brown

spi: Fix spelling typos and acronyms capitalization

Fix
  - spelling typos
  - capitalization of acronyms
in the comments.

While at it, fix the multi-line comment style.
Signed-off-by: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20230710154932.68377-16-andriy.shevchenko@linux.intel.comSigned-off-by: default avatarMark Brown <broonie@kernel.org>
parent 7a2b552c
...@@ -682,7 +682,7 @@ static int __spi_add_device(struct spi_device *spi) ...@@ -682,7 +682,7 @@ static int __spi_add_device(struct spi_device *spi)
* @spi: spi_device to register * @spi: spi_device to register
* *
* Companion function to spi_alloc_device. Devices allocated with * Companion function to spi_alloc_device. Devices allocated with
* spi_alloc_device can be added onto the spi bus with this function. * spi_alloc_device can be added onto the SPI bus with this function.
* *
* Return: 0 on success; negative errno on failure * Return: 0 on success; negative errno on failure
*/ */
...@@ -889,7 +889,7 @@ int spi_register_board_info(struct spi_board_info const *info, unsigned n) ...@@ -889,7 +889,7 @@ int spi_register_board_info(struct spi_board_info const *info, unsigned n)
* spi_res_alloc - allocate a spi resource that is life-cycle managed * spi_res_alloc - allocate a spi resource that is life-cycle managed
* during the processing of a spi_message while using * during the processing of a spi_message while using
* spi_transfer_one * spi_transfer_one
* @spi: the spi device for which we allocate memory * @spi: the SPI device for which we allocate memory
* @release: the release code to execute for this resource * @release: the release code to execute for this resource
* @size: size to alloc and return * @size: size to alloc and return
* @gfp: GFP allocation flags * @gfp: GFP allocation flags
...@@ -915,7 +915,7 @@ static void *spi_res_alloc(struct spi_device *spi, spi_res_release_t release, ...@@ -915,7 +915,7 @@ static void *spi_res_alloc(struct spi_device *spi, spi_res_release_t release,
} }
/** /**
* spi_res_free - free an spi resource * spi_res_free - free an SPI resource
* @res: pointer to the custom data of a resource * @res: pointer to the custom data of a resource
*/ */
static void spi_res_free(void *res) static void spi_res_free(void *res)
...@@ -931,7 +931,7 @@ static void spi_res_free(void *res) ...@@ -931,7 +931,7 @@ static void spi_res_free(void *res)
/** /**
* spi_res_add - add a spi_res to the spi_message * spi_res_add - add a spi_res to the spi_message
* @message: the spi message * @message: the SPI message
* @res: the spi_resource * @res: the spi_resource
*/ */
static void spi_res_add(struct spi_message *message, void *res) static void spi_res_add(struct spi_message *message, void *res)
...@@ -943,7 +943,7 @@ static void spi_res_add(struct spi_message *message, void *res) ...@@ -943,7 +943,7 @@ static void spi_res_add(struct spi_message *message, void *res)
} }
/** /**
* spi_res_release - release all spi resources for this message * spi_res_release - release all SPI resources for this message
* @ctlr: the @spi_controller * @ctlr: the @spi_controller
* @message: the @spi_message * @message: the @spi_message
*/ */
...@@ -1424,7 +1424,7 @@ int spi_delay_to_ns(struct spi_delay *_delay, struct spi_transfer *xfer) ...@@ -1424,7 +1424,7 @@ int spi_delay_to_ns(struct spi_delay *_delay, struct spi_transfer *xfer)
return -EINVAL; return -EINVAL;
/* /*
* If there is unknown effective speed, approximate it * If there is unknown effective speed, approximate it
* by underestimating with half of the requested hz. * by underestimating with half of the requested Hz.
*/ */
hz = xfer->effective_speed_hz ?: xfer->speed_hz / 2; hz = xfer->effective_speed_hz ?: xfer->speed_hz / 2;
if (!hz) if (!hz)
...@@ -1739,11 +1739,11 @@ static int __spi_pump_transfer_message(struct spi_controller *ctlr, ...@@ -1739,11 +1739,11 @@ static int __spi_pump_transfer_message(struct spi_controller *ctlr,
} }
/** /**
* __spi_pump_messages - function which processes spi message queue * __spi_pump_messages - function which processes SPI message queue
* @ctlr: controller to process queue for * @ctlr: controller to process queue for
* @in_kthread: true if we are in the context of the message pump thread * @in_kthread: true if we are in the context of the message pump thread
* *
* This function checks if there is any spi message in the queue that * This function checks if there is any SPI message in the queue that
* needs processing and if so call out to the driver to initialize hardware * needs processing and if so call out to the driver to initialize hardware
* and transfer each message. * and transfer each message.
* *
...@@ -1758,7 +1758,7 @@ static void __spi_pump_messages(struct spi_controller *ctlr, bool in_kthread) ...@@ -1758,7 +1758,7 @@ static void __spi_pump_messages(struct spi_controller *ctlr, bool in_kthread)
unsigned long flags; unsigned long flags;
int ret; int ret;
/* Take the IO mutex */ /* Take the I/O mutex */
mutex_lock(&ctlr->io_mutex); mutex_lock(&ctlr->io_mutex);
/* Lock queue */ /* Lock queue */
...@@ -2169,8 +2169,8 @@ static int __spi_queued_transfer(struct spi_device *spi, ...@@ -2169,8 +2169,8 @@ static int __spi_queued_transfer(struct spi_device *spi,
/** /**
* spi_queued_transfer - transfer function for queued transfers * spi_queued_transfer - transfer function for queued transfers
* @spi: spi device which is requesting transfer * @spi: SPI device which is requesting transfer
* @msg: spi message which is to handled is queued to driver queue * @msg: SPI message which is to handled is queued to driver queue
* *
* Return: zero on success, else a negative error code. * Return: zero on success, else a negative error code.
*/ */
...@@ -2496,7 +2496,7 @@ static int acpi_spi_count(struct acpi_resource *ares, void *data) ...@@ -2496,7 +2496,7 @@ static int acpi_spi_count(struct acpi_resource *ares, void *data)
* acpi_spi_count_resources - Count the number of SpiSerialBus resources * acpi_spi_count_resources - Count the number of SpiSerialBus resources
* @adev: ACPI device * @adev: ACPI device
* *
* Returns the number of SpiSerialBus resources in the ACPI-device's * Return: the number of SpiSerialBus resources in the ACPI-device's
* resource-list; or a negative error code. * resource-list; or a negative error code.
*/ */
int acpi_spi_count_resources(struct acpi_device *adev) int acpi_spi_count_resources(struct acpi_device *adev)
...@@ -2630,10 +2630,10 @@ static int acpi_spi_add_resource(struct acpi_resource *ares, void *data) ...@@ -2630,10 +2630,10 @@ static int acpi_spi_add_resource(struct acpi_resource *ares, void *data)
* @adev: ACPI Device for the spi device * @adev: ACPI Device for the spi device
* @index: Index of the spi resource inside the ACPI Node * @index: Index of the spi resource inside the ACPI Node
* *
* This should be used to allocate a new spi device from and ACPI Node. * This should be used to allocate a new SPI device from and ACPI Device node.
* The caller is responsible for calling spi_add_device to register the spi device. * The caller is responsible for calling spi_add_device to register the SPI device.
* *
* If ctlr is set to NULL, the Controller for the spi device will be looked up * If ctlr is set to NULL, the Controller for the SPI device will be looked up
* using the resource. * using the resource.
* If index is set to -1, index is not used. * If index is set to -1, index is not used.
* Note: If index is -1, ctlr must be set. * Note: If index is -1, ctlr must be set.
...@@ -3331,7 +3331,8 @@ void spi_unregister_controller(struct spi_controller *ctlr) ...@@ -3331,7 +3331,8 @@ void spi_unregister_controller(struct spi_controller *ctlr)
if (IS_ENABLED(CONFIG_SPI_DYNAMIC)) if (IS_ENABLED(CONFIG_SPI_DYNAMIC))
mutex_unlock(&ctlr->add_lock); mutex_unlock(&ctlr->add_lock);
/* Release the last reference on the controller if its driver /*
* Release the last reference on the controller if its driver
* has not yet been converted to devm_spi_alloc_master/slave(). * has not yet been converted to devm_spi_alloc_master/slave().
*/ */
if (!ctlr->devm_allocated) if (!ctlr->devm_allocated)
...@@ -3544,7 +3545,7 @@ static int __spi_split_transfer_maxsize(struct spi_controller *ctlr, ...@@ -3544,7 +3545,7 @@ static int __spi_split_transfer_maxsize(struct spi_controller *ctlr,
/* All the others need rx_buf/tx_buf also set */ /* All the others need rx_buf/tx_buf also set */
for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) { for (i = 1, offset = maxsize; i < count; offset += maxsize, i++) {
/* Update rx_buf, tx_buf and dma */ /* Update rx_buf, tx_buf and DMA */
if (xfers[i].rx_buf) if (xfers[i].rx_buf)
xfers[i].rx_buf += offset; xfers[i].rx_buf += offset;
if (xfers[i].rx_dma) if (xfers[i].rx_dma)
...@@ -3614,7 +3615,7 @@ EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize); ...@@ -3614,7 +3615,7 @@ EXPORT_SYMBOL_GPL(spi_split_transfers_maxsize);
/** /**
* spi_split_transfers_maxwords - split spi transfers into multiple transfers * spi_split_transfers_maxwords - split SPI transfers into multiple transfers
* when an individual transfer exceeds a * when an individual transfer exceeds a
* certain number of SPI words * certain number of SPI words
* @ctlr: the @spi_controller for this transfer * @ctlr: the @spi_controller for this transfer
...@@ -3657,7 +3658,8 @@ EXPORT_SYMBOL_GPL(spi_split_transfers_maxwords); ...@@ -3657,7 +3658,8 @@ EXPORT_SYMBOL_GPL(spi_split_transfers_maxwords);
/*-------------------------------------------------------------------------*/ /*-------------------------------------------------------------------------*/
/* Core methods for SPI controller protocol drivers. Some of the /*
* Core methods for SPI controller protocol drivers. Some of the
* other core methods are currently defined as inline functions. * other core methods are currently defined as inline functions.
*/ */
...@@ -3717,7 +3719,7 @@ static int spi_set_cs_timing(struct spi_device *spi) ...@@ -3717,7 +3719,7 @@ static int spi_set_cs_timing(struct spi_device *spi)
* changes those settings, and must be called from a context that can sleep. * changes those settings, and must be called from a context that can sleep.
* Except for SPI_CS_HIGH, which takes effect immediately, the changes take * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
* effect the next time the device is selected and data is transferred to * effect the next time the device is selected and data is transferred to
* or from it. When this function returns, the spi device is deselected. * or from it. When this function returns, the SPI device is deselected.
* *
* Note that this call will fail if the protocol driver specifies an option * Note that this call will fail if the protocol driver specifies an option
* that the underlying controller or its driver does not support. For * that the underlying controller or its driver does not support. For
...@@ -4057,7 +4059,7 @@ static int __spi_async(struct spi_device *spi, struct spi_message *message) ...@@ -4057,7 +4059,7 @@ static int __spi_async(struct spi_device *spi, struct spi_message *message)
* spi_async - asynchronous SPI transfer * spi_async - asynchronous SPI transfer
* @spi: device with which data will be exchanged * @spi: device with which data will be exchanged
* @message: describes the data transfers, including completion callback * @message: describes the data transfers, including completion callback
* Context: any (irqs may be blocked, etc) * Context: any (IRQs may be blocked, etc)
* *
* This call may be used in_irq and other contexts which can't sleep, * This call may be used in_irq and other contexts which can't sleep,
* as well as from task contexts which can sleep. * as well as from task contexts which can sleep.
...@@ -4111,7 +4113,7 @@ EXPORT_SYMBOL_GPL(spi_async); ...@@ -4111,7 +4113,7 @@ EXPORT_SYMBOL_GPL(spi_async);
* spi_async_locked - version of spi_async with exclusive bus usage * spi_async_locked - version of spi_async with exclusive bus usage
* @spi: device with which data will be exchanged * @spi: device with which data will be exchanged
* @message: describes the data transfers, including completion callback * @message: describes the data transfers, including completion callback
* Context: any (irqs may be blocked, etc) * Context: any (IRQs may be blocked, etc)
* *
* This call may be used in_irq and other contexts which can't sleep, * This call may be used in_irq and other contexts which can't sleep,
* as well as from task contexts which can sleep. * as well as from task contexts which can sleep.
...@@ -4374,9 +4376,9 @@ static u8 *buf; ...@@ -4374,9 +4376,9 @@ static u8 *buf;
/** /**
* spi_write_then_read - SPI synchronous write followed by read * spi_write_then_read - SPI synchronous write followed by read
* @spi: device with which data will be exchanged * @spi: device with which data will be exchanged
* @txbuf: data to be written (need not be dma-safe) * @txbuf: data to be written (need not be DMA-safe)
* @n_tx: size of txbuf, in bytes * @n_tx: size of txbuf, in bytes
* @rxbuf: buffer into which data will be read (need not be dma-safe) * @rxbuf: buffer into which data will be read (need not be DMA-safe)
* @n_rx: size of rxbuf, in bytes * @n_rx: size of rxbuf, in bytes
* Context: can sleep * Context: can sleep
* *
...@@ -4387,7 +4389,7 @@ static u8 *buf; ...@@ -4387,7 +4389,7 @@ static u8 *buf;
* *
* Parameters to this routine are always copied using a small buffer. * Parameters to this routine are always copied using a small buffer.
* Performance-sensitive or bulk transfer code should instead use * Performance-sensitive or bulk transfer code should instead use
* spi_{async,sync}() calls with dma-safe buffers. * spi_{async,sync}() calls with DMA-safe buffers.
* *
* Return: zero on success, else a negative error code. * Return: zero on success, else a negative error code.
*/ */
...@@ -4432,7 +4434,7 @@ int spi_write_then_read(struct spi_device *spi, ...@@ -4432,7 +4434,7 @@ int spi_write_then_read(struct spi_device *spi,
x[0].tx_buf = local_buf; x[0].tx_buf = local_buf;
x[1].rx_buf = local_buf + n_tx; x[1].rx_buf = local_buf + n_tx;
/* Do the i/o */ /* Do the I/O */
status = spi_sync(spi, &message); status = spi_sync(spi, &message);
if (status == 0) if (status == 0)
memcpy(rxbuf, x[1].rx_buf, n_rx); memcpy(rxbuf, x[1].rx_buf, n_rx);
......
This diff is collapsed.
...@@ -167,7 +167,7 @@ TRACE_EVENT(spi_message_done, ...@@ -167,7 +167,7 @@ TRACE_EVENT(spi_message_done,
); );
/* /*
* consider a buffer valid if non-NULL and if it doesn't match the dummy buffer * Consider a buffer valid if non-NULL and if it doesn't match the dummy buffer
* that only exist to work with controllers that have SPI_CONTROLLER_MUST_TX or * that only exist to work with controllers that have SPI_CONTROLLER_MUST_TX or
* SPI_CONTROLLER_MUST_RX. * SPI_CONTROLLER_MUST_RX.
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment