michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: smbus: Correct syntax in sources and headers

Browse source 
Correct syntax in SMBus sources and headers used to generate the SMBus
documentation.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2023-05-31 12:20:38 +03:00 • committed by Anas Nashif
commit cd2fe8c186
3 changed files with 18 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

2
drivers/smbus/intel_pch_smbus.c
View file

@ -2,7 +2,7 @@
* Copyright (c) 2022 Intel Corporation * Copyright (c) 2022 Intel Corporation
* *
* Intel I/O Controller Hub (ICH) later renamed to Intel Platform Controller * Intel I/O Controller Hub (ICH) later renamed to Intel Platform Controller
* Hub (PCH) SMbus driver. * Hub (PCH) SMBus driver.
* *
* PCH provides SMBus 2.0 - compliant Host Controller. * PCH provides SMBus 2.0 - compliant Host Controller.
* *

2
drivers/smbus/intel_pch_smbus.h
View file

@ -2,7 +2,7 @@
* Copyright (c) 2022 Intel Corporation * Copyright (c) 2022 Intel Corporation
* *
* Intel I/O Controller Hub (ICH) later renamed to Intel Platform Controller * Intel I/O Controller Hub (ICH) later renamed to Intel Platform Controller
* Hub (PCH) SMbus driver. * Hub (PCH) SMBus driver.
* *
* PCH provides SMBus 2.0 - compliant Host Controller. * PCH provides SMBus 2.0 - compliant Host Controller.
* *

32
include/zephyr/drivers/smbus.h
View file

@ -25,11 +25,11 @@ extern "C" {
* @name SMBus Protocol commands * @name SMBus Protocol commands
* @{ * @{
* *
* SMBus Specification defines following SMBus protocols operations * SMBus Specification defines the following SMBus protocols operations
*/ */
/** /**
* SMBus Quick protocol is very simple command with no data sent or * SMBus Quick protocol is a very simple command with no data sent or
* received. Peripheral may denote only R/W bit, which can still be * received. Peripheral may denote only R/W bit, which can still be
* used for the peripheral management, for example to switch peripheral * used for the peripheral management, for example to switch peripheral
* On/Off. Quick protocol can also be used for peripheral devices * On/Off. Quick protocol can also be used for peripheral devices
@ -69,7 +69,7 @@ extern "C" {
#define SMBUS_CMD_BYTE 0b001 #define SMBUS_CMD_BYTE 0b001
/** /**
* SMBus Byte Data protocol send first byte (command) followed * SMBus Byte Data protocol sends the first byte (command) followed
* by read or write one byte. * by read or write one byte.
* *
* @code * @code
@ -95,7 +95,7 @@ extern "C" {
#define SMBUS_CMD_BYTE_DATA 0b010 #define SMBUS_CMD_BYTE_DATA 0b010
/** /**
* SMBus Word Data protocol send first byte (command) followed * SMBus Word Data protocol sends the first byte (command) followed
* by read or write two bytes. * by read or write two bytes.
* *
* @code * @code
@ -123,9 +123,9 @@ extern "C" {
#define SMBUS_CMD_WORD_DATA 0b011 #define SMBUS_CMD_WORD_DATA 0b011
/** /**
* SMBus Process Call protocol is basically Write Word followed by * SMBus Process Call protocol is Write Word followed by
* Wead Word. It is named so because command sends data and waits * Read Word. It is named so because the command sends data and waits
* for the perihperal to return reply. * for the peripheral to return a reply.
* *
* @code * @code
* 0 1 2 * 0 1 2
@ -142,8 +142,8 @@ extern "C" {
#define SMBUS_CMD_PROC_CALL 0b100 #define SMBUS_CMD_PROC_CALL 0b100
/** /**
* SMBus Block protocol reads or writes block of data up to 32 bytes. * SMBus Block protocol reads or writes a block of data up to 32 bytes.
* Count byte specifies the amount of data. * The Count byte specifies the amount of data.
* *
* @code * @code
* *
@ -173,8 +173,8 @@ extern "C" {
#define SMBUS_CMD_BLOCK 0b101 #define SMBUS_CMD_BLOCK 0b101
/** /**
* SMBus Block Write - Block Read Process Call protocol is basically * SMBus Block Write - Block Read Process Call protocol is
* Block Write followed by Block Read * Block Write followed by Block Read.
* *
* @code * @code
* 0 1 2 * 0 1 2
@ -200,7 +200,7 @@ extern "C" {
* @name SMBus device functionality * @name SMBus device functionality
* @{ * @{
* *
* Following parameters describes functionality of SMBus device * The following parameters describe the functionality of the SMBus device
*/ */
/** Peripheral to act as Controller. */ /** Peripheral to act as Controller. */
@ -221,7 +221,7 @@ extern "C" {
* @name SMBus special reserved addresses * @name SMBus special reserved addresses
* @{ * @{
* *
* Following addresses are reserved by SMBus specification * The following addresses are reserved by SMBus specification
*/ */
/** /**
@ -241,9 +241,9 @@ extern "C" {
/** @brief SMBus read / write direction */ /** @brief SMBus read / write direction */
enum smbus_direction { enum smbus_direction {
/** Write message to SMBus */ /** Write a message to SMBus peripheral */
SMBUS_MSG_WRITE = 0, SMBUS_MSG_WRITE = 0,
/** Read message from SMBus */ /** Read a message from SMBus peripheral */
SMBUS_MSG_READ = 1, SMBUS_MSG_READ = 1,
}; };
@ -271,7 +271,7 @@ typedef void (*smbus_callback_handler_t)(const struct device *dev,
* *
* Used to register a callback in the driver instance callback list. * Used to register a callback in the driver instance callback list.
* As many callbacks as needed can be added as long as each of them * As many callbacks as needed can be added as long as each of them
* are unique pointers of struct smbus_callback. * is a unique pointer of struct smbus_callback.
* *
* Note: Such struct should not be allocated on stack. * Note: Such struct should not be allocated on stack.
*/ */