2023-10-11 07:43:43

by Tomas Winkler

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

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

2023-10-11 07:43:44

by Tomas Winkler

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

Document all entries in struct mei_cfg_idx.

Signed-off-by: Tomas Winkler <[email protected]>
---
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

2023-10-11 19:21:30

by Randy Dunlap

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

On 10/11/23 00:43, Tomas Winkler wrote:
> Document all entries in struct mei_cfg_idx.
>
> Signed-off-by: Tomas Winkler <[email protected]>

Reviewed-by: Randy Dunlap <[email protected]>

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