]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
i2c: designware: Fix spelling and other issues in the comments
authorAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Wed, 25 Sep 2024 12:44:23 +0000 (15:44 +0300)
committerAndi Shyti <andi.shyti@kernel.org>
Wed, 13 Nov 2024 22:29:47 +0000 (23:29 +0100)
Fix spelling and other issues, such as kernel-doc reported about,
in the comments. While at it, fix some indentation issues as well.

Reviewed-by: Mario Limonciello <mario.limonciello@amd.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Jarkko Nikula <jarkko.nikula@linux.intel.com>
Signed-off-by: Andi Shyti <andi.shyti@kernel.org>
drivers/i2c/busses/i2c-designware-amdpsp.c
drivers/i2c/busses/i2c-designware-common.c
drivers/i2c/busses/i2c-designware-core.h
drivers/i2c/busses/i2c-designware-master.c
drivers/i2c/busses/i2c-designware-platdrv.c
drivers/i2c/busses/i2c-designware-slave.c

index 63454b06e5da17b648c6db3e28d4a6b76b2977f0..8fbd2a10c31aad77da627517ea25041b5a3e12fb 100644 (file)
@@ -155,7 +155,7 @@ static void psp_release_i2c_bus_deferred(struct work_struct *work)
 
        /*
         * If there is any pending transaction, cannot release the bus here.
-        * psp_release_i2c_bus will take care of this later.
+        * psp_release_i2c_bus() will take care of this later.
         */
        if (psp_i2c_access_count)
                goto cleanup;
@@ -210,12 +210,12 @@ static void psp_release_i2c_bus(void)
 {
        mutex_lock(&psp_i2c_access_mutex);
 
-       /* Return early if mailbox was malfunctional */
+       /* Return early if mailbox was malfunctioned */
        if (psp_i2c_mbox_fail)
                goto cleanup;
 
        /*
-        * If we are last owner of PSP semaphore, need to release aribtration
+        * If we are last owner of PSP semaphore, need to release arbitration
         * via mailbox.
         */
        psp_i2c_access_count--;
@@ -235,9 +235,9 @@ cleanup:
 
 /*
  * Locking methods are based on the default implementation from
- * drivers/i2c/i2c-core-base.c, but with psp acquire and release operations
+ * drivers/i2c/i2c-core-base.c, but with PSP acquire and release operations
  * added. With this in place we can ensure that i2c clients on the bus shared
- * with psp are able to lock HW access to the bus for arbitrary number of
+ * with PSP are able to lock HW access to the bus for arbitrary number of
  * operations - that is e.g. write-wait-read.
  */
 static void i2c_adapter_dw_psp_lock_bus(struct i2c_adapter *adapter,
index d0b7979c2b5d51097c09acfd14f52c0462976224..5dda3c63c55122e5a32ffd240322ea39a489572a 100644 (file)
@@ -127,6 +127,8 @@ static int dw_reg_write_word(void *context, unsigned int reg, unsigned int val)
  * Autodetects needed register access mode and creates the regmap with
  * corresponding read/write callbacks. This must be called before doing any
  * other register access.
+ *
+ * Return: 0 on success, or negative errno otherwise.
  */
 int i2c_dw_init_regmap(struct dw_i2c_dev *dev)
 {
@@ -174,7 +176,7 @@ int i2c_dw_init_regmap(struct dw_i2c_dev *dev)
        /*
         * Note we'll check the return value of the regmap IO accessors only
         * at the probe stage. The rest of the code won't do this because
-        * basically we have MMIO-based regmap so non of the read/write methods
+        * basically we have MMIO-based regmap, so none of the read/write methods
         * can fail.
         */
        dev->map = devm_regmap_init(dev->dev, NULL, dev, &map_cfg);
@@ -336,7 +338,7 @@ static u32 i2c_dw_acpi_round_bus_speed(struct device *device)
 
        acpi_speed = i2c_acpi_find_bus_speed(device);
        /*
-        * Some DSTDs use a non standard speed, round down to the lowest
+        * Some DSDTs use a non standard speed, round down to the lowest
         * standard speed.
         */
        for (i = 0; i < ARRAY_SIZE(supported_speeds); i++) {
@@ -549,7 +551,7 @@ void __i2c_dw_disable(struct dw_i2c_dev *dev)
 
                /*
                 * Wait 10 times the signaling period of the highest I2C
-                * transfer supported by the driver (for 400KHz this is
+                * transfer supported by the driver (for 400kHz this is
                 * 25us) as described in the DesignWare I2C databook.
                 */
                usleep_range(25, 250);
index 70508d082e35a827cc8db9b1b7ff2f1bfd980fe5..520f9699e3bd2016e8a9e5adba8abe030e08cb1f 100644 (file)
 #define DW_IC_SLAVE                            1
 
 /*
- * Hardware abort codes from the DW_IC_TX_ABRT_SOURCE register
+ * Hardware abort codes from the DW_IC_TX_ABRT_SOURCE register.
  *
- * Only expected abort codes are listed here
- * refer to the datasheet for the full list
+ * Only expected abort codes are listed here,
+ * refer to the datasheet for the full list.
  */
 #define ABRT_7B_ADDR_NOACK                     0
 #define ABRT_10ADDR1_NOACK                     1
@@ -201,7 +201,7 @@ struct reset_control;
  * @rst: optional reset for the controller
  * @slave: represent an I2C slave device
  * @get_clk_rate_khz: callback to retrieve IP specific bus speed
- * @cmd_err: run time hadware error code
+ * @cmd_err: run time hardware error code
  * @msgs: points to an array of messages currently being transferred
  * @msgs_num: the number of elements in msgs
  * @msg_write_idx: the element index of the current tx message in the msgs array
@@ -237,7 +237,7 @@ struct reset_control;
  * @release_lock: function to release a hardware lock on the bus
  * @semaphore_idx: Index of table with semaphore type attached to the bus. It's
  *     -1 if there is no semaphore.
- * @shared_with_punit: true if this bus is shared with the SoCs PUNIT
+ * @shared_with_punit: true if this bus is shared with the SoC's PUNIT
  * @init: function to initialize the I2C hardware
  * @set_sda_hold_time: callback to retrieve IP specific SDA hold timing
  * @mode: operation mode - DW_IC_MASTER or DW_IC_SLAVE
index 09e72ead51ee42705a157b9461c4f93cb5b4bfee..528b969253a7fe24c1d65c560cc4c77ba998c655 100644 (file)
@@ -180,12 +180,14 @@ static int i2c_dw_set_timings_master(struct dw_i2c_dev *dev)
 }
 
 /**
- * i2c_dw_init_master() - Initialize the designware I2C master hardware
+ * i2c_dw_init_master() - Initialize the DesignWare I2C master hardware
  * @dev: device private data
  *
  * This functions configures and enables the I2C master.
  * This function is called during I2C init function, and in case of timeout at
  * run time.
+ *
+ * Return: 0 on success, or negative errno otherwise.
  */
 static int i2c_dw_init_master(struct dw_i2c_dev *dev)
 {
@@ -353,7 +355,7 @@ static int amd_i2c_dw_xfer_quirk(struct i2c_adapter *adap, struct i2c_msg *msgs,
                /*
                 * Initiate the i2c read/write transaction of buffer length,
                 * and poll for bus busy status. For the last message transfer,
-                * update the command with stopbit enable.
+                * update the command with stop bit enable.
                 */
                for (msg_itr_lmt = buf_len; msg_itr_lmt > 0; msg_itr_lmt--) {
                        if (msg_wrt_idx == num_msgs - 1 && msg_itr_lmt == 1)
@@ -398,7 +400,7 @@ static int amd_i2c_dw_xfer_quirk(struct i2c_adapter *adap, struct i2c_msg *msgs,
 
 /*
  * Initiate (and continue) low level master read/write transaction.
- * This function is only called from i2c_dw_isr, and pumping i2c_msg
+ * This function is only called from i2c_dw_isr(), and pumping i2c_msg
  * messages into the tx buffer.  Even if the size of i2c_msg data is
  * longer than the size of the tx buffer, it handles everything.
  */
@@ -436,7 +438,8 @@ i2c_dw_xfer_msg(struct dw_i2c_dev *dev)
                        buf = msgs[dev->msg_write_idx].buf;
                        buf_len = msgs[dev->msg_write_idx].len;
 
-                       /* If both IC_EMPTYFIFO_HOLD_MASTER_EN and
+                       /*
+                        * If both IC_EMPTYFIFO_HOLD_MASTER_EN and
                         * IC_RESTART_EN are set, we must manually
                         * set restart bit between messages.
                         */
@@ -967,7 +970,7 @@ static int i2c_dw_init_recovery_info(struct dw_i2c_dev *dev)
        rinfo->unprepare_recovery = i2c_dw_unprepare_recovery;
        adap->bus_recovery_info = rinfo;
 
-       dev_info(dev->dev, "running with gpio recovery mode! scl%s",
+       dev_info(dev->dev, "running with GPIO recovery mode! scl%s",
                 rinfo->sda_gpiod ? ",sda" : "");
 
        return 0;
index a3e86930bf41866aefcd93e8c6373d181d777489..b44c5d1a6748176c0824ef1b4b928683fe18aa87 100644 (file)
@@ -72,7 +72,7 @@ static int bt1_i2c_write(void *context, unsigned int reg, unsigned int val)
                return ret;
 
        return regmap_write(dev->sysmap, BT1_I2C_CTL,
-               BT1_I2C_CTL_GO | BT1_I2C_CTL_WR | (reg & BT1_I2C_CTL_ADDR_MASK));
+                           BT1_I2C_CTL_GO | BT1_I2C_CTL_WR | (reg & BT1_I2C_CTL_ADDR_MASK));
 }
 
 static const struct regmap_config bt1_i2c_cfg = {
@@ -278,7 +278,7 @@ static int dw_i2c_plat_probe(struct platform_device *pdev)
        adap = &dev->adapter;
        adap->owner = THIS_MODULE;
        adap->class = dmi_check_system(dw_i2c_hwmon_class_dmi) ?
-                                       I2C_CLASS_HWMON : I2C_CLASS_DEPRECATED;
+                                      I2C_CLASS_HWMON : I2C_CLASS_DEPRECATED;
        adap->nr = -1;
 
        if (dev->flags & ACCESS_NO_IRQ_SUSPEND)
index 7035296aa24ce0a65d99f7da43cb36c71f4e41fb..fad568e3523b91c483845017e9f1dc0eb9de3a0f 100644 (file)
@@ -32,12 +32,14 @@ static void i2c_dw_configure_fifo_slave(struct dw_i2c_dev *dev)
 }
 
 /**
- * i2c_dw_init_slave() - Initialize the designware i2c slave hardware
+ * i2c_dw_init_slave() - Initialize the DesignWare i2c slave hardware
  * @dev: device private data
  *
  * This function configures and enables the I2C in slave mode.
  * This function is called during I2C init function, and in case of timeout at
  * run time.
+ *
+ * Return: 0 on success, or negative errno otherwise.
  */
 static int i2c_dw_init_slave(struct dw_i2c_dev *dev)
 {
@@ -264,7 +266,7 @@ int i2c_dw_probe_slave(struct dw_i2c_dev *dev)
        ret = devm_request_irq(dev->dev, dev->irq, i2c_dw_isr_slave,
                               IRQF_SHARED, dev_name(dev->dev), dev);
        if (ret) {
-               dev_err(dev->dev, "failure requesting irq %i: %d\n",
+               dev_err(dev->dev, "failure requesting IRQ %i: %d\n",
                        dev->irq, ret);
                return ret;
        }