net/caif/caif_layer.h

36  * enum caif_ctrlcmd - CAIF Stack Control Signaling sent in layer.ctrlcmd().
47  * @CAIF_CTRLCMD_INIT_RSP:		Called initially when the layer below
55  * @_CAIF_CTRLCMD_PHYIF_FLOW_OFF_IND:	CAIF Link layer temporarily cannot
57  * @_CAIF_CTRLCMD_PHYIF_FLOW_ON_IND:	Called if CAIF Link layer is able
59  * @_CAIF_CTRLCMD_PHYIF_DOWN_IND:	Called if CAIF Link layer is going
63  * They are used for signaling originating from the modem or CAIF Link Layer.
80  *			 to the CAIF Link Layer or modem.
88  * @_CAIF_MODEMCMD_PHYIF_USEFULL:	Notify physical layer that it is in use
90  * @_CAIF_MODEMCMD_PHYIF_USELESS:	Notify physical layer that it is
115  * struct cflayer - CAIF Stack layer.
117  * @up:		Pointer up to the layer above.
118  * @dn:		Pointer down to the layer below.
119  * @node:	List node used when layer participate in a list.
124  * @id:		The identity of this layer
125  * @name:	Name of the layer.
132  *  In order to integrate with CAIF an adaptation layer on top of the CAIF stack
133  *  and PHY layer below the CAIF stack
134  *  must be implemented. These layer must follow the design principles below.
138  *	structure first in the layer specific structure.
140  *    - Each layer should not depend on any others layer's private data.
143  *	layer->up->receive(layer->up, packet);
146  *	layer->dn->transmit(layer->dn, info, packet);
155 	 *  Contract: Each layer must implement a receive function passing the
161 	 *		above layer using up->receive().
166 	 *		EXCEPTION: If the framing layer (cffrml) returns
175 	 *  @layr: Pointer to the current layer the receive function is
183 	 *  Contract: Each layer must implement a transmit function passing the
189 	 *		layer using dn->transmit().
202 	 *  @layr:	Pointer to the current layer the receive function
213 	 *  @layr:	Pointer to the current layer the receive function
225 	 *  @layr:	Pointer to the current layer the receive function
236  * layer_set_up() - Set the up pointer for a specified layer.
237  *  @layr: Layer where up pointer shall be set.
238  *  @above: Layer above.
243  *  layer_set_dn() - Set the down pointer for a specified layer.
244  *  @layr:  Layer where down pointer shall be set.
245  *  @below: Layer below.
250  * struct dev_info - Physical Device info information about physical layer.