[char-misc-next 0/3] mei: documentation fixes

[char-misc-next 0/3] mei: documentation fixes

[Tomas Winkler]

Fix spelling errors and kdoc issues.


Tomas Winkler (3):
  mei: docs: use correct structures name in kdoc
  mei: docs: add missing entries to kdoc in struct mei_cfg_idx
  mei: docs: fix spelling errors

 drivers/misc/mei/bus.c       | 4 ++--
 drivers/misc/mei/dma-ring.c  | 2 +-
 drivers/misc/mei/hbm.c       | 4 ++--
 drivers/misc/mei/hw-me.h     | 4 ++++
 drivers/misc/mei/hw.h        | 4 ++--
 drivers/misc/mei/interrupt.c | 2 +-
 drivers/misc/mei/mei_dev.h   | 4 ++--
 include/linux/mei_cl_bus.h   | 4 ++--
 8 files changed, 16 insertions(+), 12 deletions(-)

-- 
2.41.0

[char-misc-next 1/3] mei: docs: use correct structures name in kdoc

[Tomas Winkler]

Fix misalignment between structures names and their kdoc in hw.h

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
 drivers/misc/mei/hw.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/misc/mei/hw.h b/drivers/misc/mei/hw.h
index e910302fcd1f6a28c13fa46c..3ad3080519c42521d8643396 100644
--- a/drivers/misc/mei/hw.h
+++ b/drivers/misc/mei/hw.h
@@ -429,7 +429,7 @@ struct mei_bus_message {
 } __packed;
 
 /**
- * struct hbm_cl_cmd - client specific host bus command
+ * struct mei_hbm_cl_cmd - client specific host bus command
  *	CONNECT, DISCONNECT, and FlOW CONTROL
  *
  * @hbm_cmd: bus message command header
@@ -733,7 +733,7 @@ struct hbm_dma_setup_response {
 } __packed;
 
 /**
- * struct mei_dma_ring_ctrl - dma ring control block
+ * struct hbm_dma_ring_ctrl - dma ring control block
  *
  * @hbuf_wr_idx: host circular buffer write index in slots
  * @reserved1: reserved for alignment
-- 
2.41.0

[char-misc-next 2/3] mei: docs: add missing entries to kdoc in struct mei_cfg_idx

[Tomas Winkler]

Document all entries in struct mei_cfg_idx.

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
 drivers/misc/mei/hw-me.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/misc/mei/hw-me.h b/drivers/misc/mei/hw-me.h
index 95cf830b7c7b63e1cf555048..204b92af6c4785beb23f0212 100644
--- a/drivers/misc/mei/hw-me.h
+++ b/drivers/misc/mei/hw-me.h
@@ -102,10 +102,14 @@ static inline bool mei_me_hw_use_polling(const struct mei_me_hw *hw)
  * @MEI_ME_PCH12_SPS_CFG:  Platform Controller Hub Gen12 5.0 and newer
  *                         servers platforms with quirk for
  *                         SPS firmware exclusion.
+ * @MEI_ME_PCH12_SPS_ITOUCH_CFG: Platform Controller Hub Gen12
+ *                         client platforms (iTouch)
  * @MEI_ME_PCH15_CFG:      Platform Controller Hub Gen15 and newer
  * @MEI_ME_PCH15_SPS_CFG:  Platform Controller Hub Gen15 and newer
  *                         servers platforms with quirk for
  *                         SPS firmware exclusion.
+ * @MEI_ME_GSC_CFG:        Graphics System Controller
+ * @MEI_ME_GSCFI_CFG:      Graphics System Controller Firmware Interface
  * @MEI_ME_NUM_CFG:        Upper Sentinel.
  */
 enum mei_cfg_idx {
-- 
2.41.0

[char-misc-next 3/3] mei: docs: fix spelling errors

[Tomas Winkler]

Fix spelling errors in the mei code base.

Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
---
 drivers/misc/mei/bus.c       | 4 ++--
 drivers/misc/mei/dma-ring.c  | 2 +-
 drivers/misc/mei/hbm.c       | 4 ++--
 drivers/misc/mei/interrupt.c | 2 +-
 drivers/misc/mei/mei_dev.h   | 4 ++--
 include/linux/mei_cl_bus.h   | 4 ++--
 6 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/drivers/misc/mei/bus.c b/drivers/misc/mei/bus.c
index 2e65ce6bdec7d9c561ccd2c8..67557c67bd214415b8dc6747 100644
--- a/drivers/misc/mei/bus.c
+++ b/drivers/misc/mei/bus.c
@@ -1301,7 +1301,7 @@ static inline void mei_cl_bus_set_name(struct mei_cl_device *cldev)
  * @bus: mei device
  * @me_cl: me client
  *
- * Return: allocated device structur or NULL on allocation failure
+ * Return: allocated device structure or NULL on allocation failure
  */
 static struct mei_cl_device *mei_cl_bus_dev_alloc(struct mei_device *bus,
 						  struct mei_me_client *me_cl)
@@ -1361,7 +1361,7 @@ static bool mei_cl_bus_dev_setup(struct mei_device *bus,
  *
  * @cldev: me client device
  *
- * Return: 0 on success; < 0 on failre
+ * Return: 0 on success; < 0 on failure
  */
 static int mei_cl_bus_dev_add(struct mei_cl_device *cldev)
 {
diff --git a/drivers/misc/mei/dma-ring.c b/drivers/misc/mei/dma-ring.c
index ef56f849b251d77b87767d48..e5d800e68cb186ce82d715b6 100644
--- a/drivers/misc/mei/dma-ring.c
+++ b/drivers/misc/mei/dma-ring.c
@@ -161,7 +161,7 @@ static size_t mei_dma_copy_to(struct mei_device *dev, unsigned char *buf,
 /**
  * mei_dma_ring_read() - read data from the ring
  * @dev: mei device
- * @buf: buffer to read into: may be NULL in case of droping the data.
+ * @buf: buffer to read into: may be NULL in case of dropping the data.
  * @len: length to read.
  */
 void mei_dma_ring_read(struct mei_device *dev, unsigned char *buf, u32 len)
diff --git a/drivers/misc/mei/hbm.c b/drivers/misc/mei/hbm.c
index 12a62a911e4237aad8bc381b..15737655c896c8b5835288ea 100644
--- a/drivers/misc/mei/hbm.c
+++ b/drivers/misc/mei/hbm.c
@@ -111,7 +111,7 @@ void mei_hbm_idle(struct mei_device *dev)
 }
 
 /**
- * mei_hbm_reset - reset hbm counters and book keeping data structurs
+ * mei_hbm_reset - reset hbm counters and book keeping data structures
  *
  * @dev: the device structure
  */
@@ -907,7 +907,7 @@ int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
 }
 
 /**
- * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
+ * mei_hbm_cl_disconnect_rsp - sends disconnect response to the FW
  *
  * @dev: the device structure
  * @cl: a client to disconnect from
diff --git a/drivers/misc/mei/interrupt.c b/drivers/misc/mei/interrupt.c
index 0a0e984e56736cd0ece88f41..5a050f50f33e3a6a64e7c7c2 100644
--- a/drivers/misc/mei/interrupt.c
+++ b/drivers/misc/mei/interrupt.c
@@ -72,7 +72,7 @@ static void mei_irq_discard_msg(struct mei_device *dev, struct mei_msg_hdr *hdr,
 		discard_len = 0;
 	}
 	/*
-	 * no need to check for size as it is guarantied
+	 * no need to check for size as it is guaranteed
 	 * that length fits into rd_msg_buf
 	 */
 	mei_read_slots(dev, dev->rd_msg_buf, discard_len);
diff --git a/drivers/misc/mei/mei_dev.h b/drivers/misc/mei/mei_dev.h
index cdf8a2edf0b32b7dd6a0af53..fca0094a2310e4a2710883ac 100644
--- a/drivers/misc/mei/mei_dev.h
+++ b/drivers/misc/mei/mei_dev.h
@@ -70,9 +70,9 @@ enum mei_dev_state {
 /**
  * enum mei_dev_pxp_mode - MEI PXP mode state
  *
- * @MEI_DEV_PXP_DEFAULT: PCH based device, no initailization required
+ * @MEI_DEV_PXP_DEFAULT: PCH based device, no initialization required
  * @MEI_DEV_PXP_INIT:    device requires initialization, send setup message to firmware
- * @MEI_DEV_PXP_SETUP:   device is in setup stage, waiting for firmware repsonse
+ * @MEI_DEV_PXP_SETUP:   device is in setup stage, waiting for firmware response
  * @MEI_DEV_PXP_READY:   device initialized
  */
 enum mei_dev_pxp_mode {
diff --git a/include/linux/mei_cl_bus.h b/include/linux/mei_cl_bus.h
index fd6e0620658d6515b3e234ce..c9af62e54577033bf9bae0e4 100644
--- a/include/linux/mei_cl_bus.h
+++ b/include/linux/mei_cl_bus.h
@@ -31,11 +31,11 @@ typedef void (*mei_cldev_cb_t)(struct mei_cl_device *cldev);
  * @rx_work: async work to execute Rx event callback
  * @rx_cb: Drivers register this callback to get asynchronous ME
  *	Rx buffer pending notifications.
- * @notif_work: async work to execute FW notif event callback
+ * @notif_work: async work to execute FW notify event callback
  * @notif_cb: Drivers register this callback to get asynchronous ME
  *	FW notification pending notifications.
  *
- * @do_match: wheather device can be matched with a driver
+ * @do_match: whether the device can be matched with a driver
  * @is_added: device is already scanned
  * @priv_data: client private data
  */
-- 
2.41.0

Re: [char-misc-next 2/3] mei: docs: add missing entries to kdoc in struct mei_cfg_idx

[Randy Dunlap]

On 10/11/23 00:43, Tomas Winkler wrote:
> Document all entries in struct mei_cfg_idx.
> 
> Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.


> ---
>  drivers/misc/mei/hw-me.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/misc/mei/hw-me.h b/drivers/misc/mei/hw-me.h
> index 95cf830b7c7b63e1cf555048..204b92af6c4785beb23f0212 100644
> --- a/drivers/misc/mei/hw-me.h
> +++ b/drivers/misc/mei/hw-me.h
> @@ -102,10 +102,14 @@ static inline bool mei_me_hw_use_polling(const struct mei_me_hw *hw)
>   * @MEI_ME_PCH12_SPS_CFG:  Platform Controller Hub Gen12 5.0 and newer
>   *                         servers platforms with quirk for
>   *                         SPS firmware exclusion.
> + * @MEI_ME_PCH12_SPS_ITOUCH_CFG: Platform Controller Hub Gen12
> + *                         client platforms (iTouch)
>   * @MEI_ME_PCH15_CFG:      Platform Controller Hub Gen15 and newer
>   * @MEI_ME_PCH15_SPS_CFG:  Platform Controller Hub Gen15 and newer
>   *                         servers platforms with quirk for
>   *                         SPS firmware exclusion.
> + * @MEI_ME_GSC_CFG:        Graphics System Controller
> + * @MEI_ME_GSCFI_CFG:      Graphics System Controller Firmware Interface
>   * @MEI_ME_NUM_CFG:        Upper Sentinel.
>   */
>  enum mei_cfg_idx {

-- 
~Randy

Re: [char-misc-next 1/3] mei: docs: use correct structures name in kdoc

[Randy Dunlap]

On 10/11/23 00:42, Tomas Winkler wrote:
> Fix misalignment between structures names and their kdoc in hw.h
> 
> Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  drivers/misc/mei/hw.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/misc/mei/hw.h b/drivers/misc/mei/hw.h
> index e910302fcd1f6a28c13fa46c..3ad3080519c42521d8643396 100644
> --- a/drivers/misc/mei/hw.h
> +++ b/drivers/misc/mei/hw.h
> @@ -429,7 +429,7 @@ struct mei_bus_message {
>  } __packed;
>  
>  /**
> - * struct hbm_cl_cmd - client specific host bus command
> + * struct mei_hbm_cl_cmd - client specific host bus command
>   *	CONNECT, DISCONNECT, and FlOW CONTROL
>   *
>   * @hbm_cmd: bus message command header
> @@ -733,7 +733,7 @@ struct hbm_dma_setup_response {
>  } __packed;
>  
>  /**
> - * struct mei_dma_ring_ctrl - dma ring control block
> + * struct hbm_dma_ring_ctrl - dma ring control block
>   *
>   * @hbuf_wr_idx: host circular buffer write index in slots
>   * @reserved1: reserved for alignment

-- 
~Randy

Re: [char-misc-next 3/3] mei: docs: fix spelling errors

[Randy Dunlap]

On 10/11/23 00:43, Tomas Winkler wrote:
> Fix spelling errors in the mei code base.
> 
> Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
> ---
>  drivers/misc/mei/bus.c       | 4 ++--
>  drivers/misc/mei/dma-ring.c  | 2 +-
>  drivers/misc/mei/hbm.c       | 4 ++--
>  drivers/misc/mei/interrupt.c | 2 +-
>  drivers/misc/mei/mei_dev.h   | 4 ++--
>  include/linux/mei_cl_bus.h   | 4 ++--
>  6 files changed, 10 insertions(+), 10 deletions(-)
> 
> diff --git a/drivers/misc/mei/bus.c b/drivers/misc/mei/bus.c
> index 2e65ce6bdec7d9c561ccd2c8..67557c67bd214415b8dc6747 100644
> --- a/drivers/misc/mei/bus.c
> +++ b/drivers/misc/mei/bus.c
> @@ -1301,7 +1301,7 @@ static inline void mei_cl_bus_set_name(struct mei_cl_device *cldev)
>   * @bus: mei device
>   * @me_cl: me client
>   *
> - * Return: allocated device structur or NULL on allocation failure
> + * Return: allocated device structure or NULL on allocation failure
>   */
>  static struct mei_cl_device *mei_cl_bus_dev_alloc(struct mei_device *bus,
>  						  struct mei_me_client *me_cl)
> @@ -1361,7 +1361,7 @@ static bool mei_cl_bus_dev_setup(struct mei_device *bus,
>   *
>   * @cldev: me client device
>   *
> - * Return: 0 on success; < 0 on failre
> + * Return: 0 on success; < 0 on failure
>   */
>  static int mei_cl_bus_dev_add(struct mei_cl_device *cldev)
>  {
> diff --git a/drivers/misc/mei/dma-ring.c b/drivers/misc/mei/dma-ring.c
> index ef56f849b251d77b87767d48..e5d800e68cb186ce82d715b6 100644
> --- a/drivers/misc/mei/dma-ring.c
> +++ b/drivers/misc/mei/dma-ring.c
> @@ -161,7 +161,7 @@ static size_t mei_dma_copy_to(struct mei_device *dev, unsigned char *buf,
>  /**
>   * mei_dma_ring_read() - read data from the ring
>   * @dev: mei device
> - * @buf: buffer to read into: may be NULL in case of droping the data.
> + * @buf: buffer to read into: may be NULL in case of dropping the data.
>   * @len: length to read.
>   */
>  void mei_dma_ring_read(struct mei_device *dev, unsigned char *buf, u32 len)
> diff --git a/drivers/misc/mei/hbm.c b/drivers/misc/mei/hbm.c
> index 12a62a911e4237aad8bc381b..15737655c896c8b5835288ea 100644
> --- a/drivers/misc/mei/hbm.c
> +++ b/drivers/misc/mei/hbm.c
> @@ -111,7 +111,7 @@ void mei_hbm_idle(struct mei_device *dev)
>  }
>  
>  /**
> - * mei_hbm_reset - reset hbm counters and book keeping data structurs
> + * mei_hbm_reset - reset hbm counters and book keeping data structures

s/book keeping/bookkeeping/

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

>   *
>   * @dev: the device structure
>   */
> @@ -907,7 +907,7 @@ int mei_hbm_cl_disconnect_req(struct mei_device *dev, struct mei_cl *cl)
>  }
>  
>  /**
> - * mei_hbm_cl_disconnect_rsp - sends disconnect respose to the FW
> + * mei_hbm_cl_disconnect_rsp - sends disconnect response to the FW
>   *
>   * @dev: the device structure
>   * @cl: a client to disconnect from
> diff --git a/drivers/misc/mei/interrupt.c b/drivers/misc/mei/interrupt.c
> index 0a0e984e56736cd0ece88f41..5a050f50f33e3a6a64e7c7c2 100644
> --- a/drivers/misc/mei/interrupt.c
> +++ b/drivers/misc/mei/interrupt.c
> @@ -72,7 +72,7 @@ static void mei_irq_discard_msg(struct mei_device *dev, struct mei_msg_hdr *hdr,
>  		discard_len = 0;
>  	}
>  	/*
> -	 * no need to check for size as it is guarantied
> +	 * no need to check for size as it is guaranteed
>  	 * that length fits into rd_msg_buf
>  	 */
>  	mei_read_slots(dev, dev->rd_msg_buf, discard_len);
> diff --git a/drivers/misc/mei/mei_dev.h b/drivers/misc/mei/mei_dev.h
> index cdf8a2edf0b32b7dd6a0af53..fca0094a2310e4a2710883ac 100644
> --- a/drivers/misc/mei/mei_dev.h
> +++ b/drivers/misc/mei/mei_dev.h
> @@ -70,9 +70,9 @@ enum mei_dev_state {
>  /**
>   * enum mei_dev_pxp_mode - MEI PXP mode state
>   *
> - * @MEI_DEV_PXP_DEFAULT: PCH based device, no initailization required
> + * @MEI_DEV_PXP_DEFAULT: PCH based device, no initialization required
>   * @MEI_DEV_PXP_INIT:    device requires initialization, send setup message to firmware
> - * @MEI_DEV_PXP_SETUP:   device is in setup stage, waiting for firmware repsonse
> + * @MEI_DEV_PXP_SETUP:   device is in setup stage, waiting for firmware response
>   * @MEI_DEV_PXP_READY:   device initialized
>   */
>  enum mei_dev_pxp_mode {
> diff --git a/include/linux/mei_cl_bus.h b/include/linux/mei_cl_bus.h
> index fd6e0620658d6515b3e234ce..c9af62e54577033bf9bae0e4 100644
> --- a/include/linux/mei_cl_bus.h
> +++ b/include/linux/mei_cl_bus.h
> @@ -31,11 +31,11 @@ typedef void (*mei_cldev_cb_t)(struct mei_cl_device *cldev);
>   * @rx_work: async work to execute Rx event callback
>   * @rx_cb: Drivers register this callback to get asynchronous ME
>   *	Rx buffer pending notifications.
> - * @notif_work: async work to execute FW notif event callback
> + * @notif_work: async work to execute FW notify event callback
>   * @notif_cb: Drivers register this callback to get asynchronous ME
>   *	FW notification pending notifications.
>   *
> - * @do_match: wheather device can be matched with a driver
> + * @do_match: whether the device can be matched with a driver
>   * @is_added: device is already scanned
>   * @priv_data: client private data
>   */

-- 
~Randy