• Luca Ceresoli's avatar
    docs: i2c: i2c-topology: reorder sections more logically · 92d5d643
    Luca Ceresoli authored
    The sequence of sections is a bit confusing here:
    
     * we list the mux locking scheme for existing drivers before introducing
       what mux locking schemes are
     * we list the caveats for each locking scheme (which are tricky) before
       the example of the simple use case
    
    Restructure it entirely with the following logic:
    
     * Intro ("I2C muxes and complex topologies")
     * Locking
       - mux-locked
         - example
         - caveats
       - parent-locked
         - example
         - caveats
     * Complex examples
     * Mux type of existing device drivers
    
    While there, also apply some other improvements:
    
     * convert the caveat list from a table (with only one column carrying
       content) to a bullet list.
     * add a small introductory text to bridge the gap from listing the use
       cases to telling about the hardware components to handle them and then
       the device drivers that implement those.
     * make empty lines usage more uniform
    Signed-off-by: default avatarLuca Ceresoli <luca.ceresoli@bootlin.com>
    Acked-by: default avatarPeter Rosin <peda@axentia.se>
    Signed-off-by: default avatarWolfram Sang <wsa@kernel.org>
    92d5d643
i2c-topology.rst 15.8 KB