Skip to content

F
FMC Software Support
Commit 05a19828 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

doc: sphinx fixes 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent 6d9fd555
Hide whitespace changes
Inline Side-by-side
Showing with 7 additions and 5 deletions
Documentation/fmc/fmc-carrier.rst
View file @ 05a19828
......@@ -34,6 +34,7 @@ Before being able to register your device as an FMC carrier you should:
is left to the carrier driver which has full knowledge. Then, the carrier
driver informs the FMC framework about which I2C bus must be used to access
an FMC slot. This approach makes the use of the I2C bus more flexible:
- the carrier is free to connect devices on the bus
- the carrier can delegate the FMC framework to handle I2C devices on an
FMC slot.
......@@ -61,7 +62,7 @@ Once a device has been registered as an FMC carrier, automatically the FMC
framework registers a device instance for each slot. For each of them, an
I2C EEPROM instance (type 'at24c02') will be created.
If the carrier driver needs the associated :c:type:`struct fmc_carrier`
If the carrier driver needs the associated :c:type:`struct fmc_carrier <fmc_carrier>`
instance, it can obtained by using :c:func:`fmc_carrier_get()`.
This will increment the device reference counter, so when you are done with
it, remember to release it with :c:func:`fmc_carrier_put()`. But in principle
......
Documentation/fmc/fmc-device.rst
View file @ 05a19828
......@@ -10,14 +10,14 @@ Use The FMC Framework From Devices
==================================
Devices requiring access to FMC information need to get the slot
structure :c:type:`struct fmc_slot` in which they are interested by
structure :c:type:`struct fmc_slot <fmc_slot>` in which they are interested by
calling :c:func:`fmc_slot_get()`. This will increment the device reference
counter, so when you are done with it, remember to release it with
:c:func:`fmc_slot_put()`.
Having a valid pointer to :c:type:`struct fmc_slot` enables the device
to use the following functions :c:func:`fmc_slot_present()` and
:c:func:`fmc_slot_fru_valid()`.
Having a valid pointer to :c:type:`struct fmc_slot <fmc_slot>` enables
the device to use the following functions :c:func:`fmc_slot_present()`
and :c:func:`fmc_slot_fru_valid()`.
As describe in :ref:`fmc_intro_i2c_dev`, FMC modules may have other I2C
devices connected on the same I2C bus used to access the EEPROM with the
......
Documentation/fmc/index.rst
View file @ 05a19828
......@@ -7,6 +7,7 @@
.. toctree::
:maxdepth: 2
fmc-introduction
fmc-carrier
fmc-device
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment