docs: i2c: i2c-topology: reorder sections more logically - linux-dev - Linux kernel development work

diff options

author	Luca Ceresoli <luca.ceresoli@bootlin.com>	2022-08-24 10:31:04 +0200
committer	Wolfram Sang <wsa@kernel.org>	2022-08-29 12:28:13 +0200
commit	92d5d6434d285510a3563ebace24306e240615e1 (patch)
tree	65083dd82943190da1c7e5cccef9153ff82e60e2 /Documentation/driver-api/serial/ssh:/git@git.zx2c4.com
parent	docs: i2c: i2c-topology: fix incorrect heading (diff)

docs: i2c: i2c-topology: reorder sections more logically

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: Luca Ceresoli <luca.ceresoli@bootlin.com> Acked-by: Peter Rosin <peda@axentia.se> Signed-off-by: Wolfram Sang <wsa@kernel.org>

Diffstat (limited to 'Documentation/driver-api/serial/ssh:/git@git.zx2c4.com')

0 files changed, 0 insertions, 0 deletions

/* p80211meta.h * * Macros, constants, types, and funcs for p80211 metadata * * Copyright (C) 1999 AbsoluteValue Systems, Inc. All Rights Reserved. * -------------------------------------------------------------------- * * linux-wlan * * The contents of this file are subject to the Mozilla Public * License Version 1.1 (the "License"); you may not use this file * except in compliance with the License. You may obtain a copy of * the License at http://www.mozilla.org/MPL/ * * Software distributed under the License is distributed on an "AS * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or * implied. See the License for the specific language governing * rights and limitations under the License. * * Alternatively, the contents of this file may be used under the * terms of the GNU Public License version 2 (the "GPL"), in which * case the provisions of the GPL are applicable instead of the * above. If you wish to allow the use of your version of this file * only under the terms of the GPL and not to allow others to use * your version of this file under the MPL, indicate your decision * by deleting the provisions above and replace them with the notice * and other provisions required by the GPL. If you do not delete * the provisions above, a recipient may use your version of this * file under either the MPL or the GPL. * * -------------------------------------------------------------------- * * Inquiries regarding the linux-wlan Open Source project can be * made directly to: * * AbsoluteValue Systems Inc. * info@linux-wlan.com * http://www.linux-wlan.com * * -------------------------------------------------------------------- * * Portions of the development of this software were funded by * Intersil Corporation as part of PRISM(R) chipset product development. * * -------------------------------------------------------------------- * * This file declares some of the constants and types used in various * parts of the linux-wlan system. * * Notes: * - Constant values are always in HOST byte order. * * All functions and statics declared here are implemented in p80211types.c * -------------------------------------------------------------------- */ #ifndef _P80211META_H #define _P80211META_H /*----------------------------------------------------------------*/ /* The following structure types are used for the metadata */ /* representation of category list metadata, group list metadata, */ /* and data item metadata for both Mib and Messages. */ struct p80211meta { char *name; /* data item name */ u32 did; /* partial did */ u32 flags; /* set of various flag bits */ u32 min; /* min value of a BOUNDEDint */ u32 max; /* max value of a BOUNDEDint */ u32 maxlen; /* maxlen of a OCTETSTR or DISPLAYSTR */ u32 minlen; /* minlen of a OCTETSTR or DISPLAYSTR */ p80211enum_t *enumptr; /* ptr to the enum type for ENUMint */ p80211_totext_t totextptr; /* ptr to totext conversion function */ p80211_fromtext_t fromtextptr; /* ptr to totext conversion function */ p80211_valid_t validfunptr; /* ptr to totext conversion function */ }; struct grplistitem { char *name; struct p80211meta *itemlist; }; struct catlistitem { char *name; struct grplistitem *grplist; }; #endif /* _P80211META_H */


context:
space:
mode: