michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: smbus: Correct SMBus documentation

Browse source 
Fix syntax errors in the documentation.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
This commit is contained in:
Andrei Emeltchenko 2023-05-30 18:26:51 +03:00 • committed by Anas Nashif
commit 21f59903c7
1 changed files with 14 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

28
doc/hardware/peripherals/smbus.rst
View file

@ -13,26 +13,26 @@ Overview
System Management Bus (SMBus) is derived from I2C for communication System Management Bus (SMBus) is derived from I2C for communication
with devices on the motherboard. A system may use SMBus to communicate with devices on the motherboard. A system may use SMBus to communicate
with the peripherals on the motherboard without using dedicated control with the peripherals on the motherboard without using dedicated control
lines. With SMBus peripheral can provide various manufacturer information, lines. SMBus peripherals can provide various manufacturer information,
report errors, accept control parameters, etc. report errors, accept control parameters, etc.
Devices on the bus can operate in three roles: as a "controller" that Devices on the bus can operate in three roles: as a Controller that
initiates transactions and controls the clock, a "peripheral" that initiates transactions and controls the clock, a Peripheral that
responds to transaction commands, or a "host", which is a specialized responds to transaction commands, or a Host, which is a specialized
controller, that provides the main interface to the system's CPU. Controller, that provides the main interface to the system's CPU.
Zephyr has API for "controller" role. Zephyr has API for the Controller role.
In SMBus peripheral devices can initiate communication with Controller SMBus peripheral devices can initiate communication with Controller
with two methods: with two methods:
* **Host Notify protocol**: Peripheral device that supports Host Notify * **Host Notify protocol**: Peripheral device that supports the Host Notify
protocol behaive as a Controller to perform the notification. It writes protocol behaves as a Controller to perform the notification. It writes
three-bytes message to a special address "SMBus Host (0x08)" with own a three-bytes message to a special address "SMBus Host (0x08)" with own
address and two bytes of relevant data. address and two bytes of relevant data.
* **SMBALERT# signal**: Peripheral device uses special signal SMBALERT# to * **SMBALERT# signal**: Peripheral device uses special signal SMBALERT# to
to request attention from the Controller. Controller needs to read one byte request attention from the Controller. The Controller needs to read one byte
from the special "SMBus Alert Response Address (ARA) (0x0c)". The peripheral from the special "SMBus Alert Response Address (ARA) (0x0c)". The peripheral
device responds with data byte containing own address. device responds with a data byte containing its own address.
Currently, the API is based on `SMBus Specification`_ version 2.0 Currently, the API is based on `SMBus Specification`_ version 2.0
@ -46,8 +46,8 @@ SMBus Controller API
******************** ********************
Zephyr's SMBus controller API is used when an SMBus device controls the bus, Zephyr's SMBus controller API is used when an SMBus device controls the bus,
in particularly the start and stop conditions and the clock. This is particularly the start and stop conditions and the clock. This is
the most common mode, used to interact with SMbus peripherals. the most common mode used to interact with SMBus peripherals.
Configuration Options Configuration Options
********************* *********************