net/caif/caif_layer.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Copyright (C) ST-Ericsson AB 2010
10 #include <linux/list.h>
21  * caif_assert() - Assert function for CAIF.
36  * enum caif_ctrlcmd - CAIF Stack Control Signaling sent in layer.ctrlcmd().
50  * @CAIF_CTRLCMD_DEINIT_RSP:		Called when de-initialization is
79  * enum caif_modemcmd -	 Modem Control Signaling, sent from CAIF Client
104  * enum caif_direction - CAIF Packet Direction.
115  * struct cflayer - CAIF Stack layer.
119  * @node:	List node used when layer participate in a list.
137  *    - All layers must use this structure. If embedding it, then place this
140  *    - Each layer should not depend on any others layer's private data.
142  *    - In order to send data upwards do
143  *	layer->up->receive(layer->up, packet);
145  *    - In order to send data downwards do
146  *	layer->dn->transmit(layer->dn, info, packet);
154 	 *  receive() - Receive Function (non-blocking).
158 	 *	      - The CAIF packet (cfpkt) ownership is passed to the
161 	 *		above layer using up->receive().
163 	 *	      - If parsing of the packet fails, the packet must be
167 	 *			-EILSEQ, the packet is not freed.
169 	 *	      - If parsing succeeds (and above layers return OK) then
182 	 *  transmit() - Transmit Function (non-blocking).
186 	 *	      - The CAIF packet (cfpkt) ownership is passed to the
189 	 *		layer using dn->transmit().
191 	 *	      - Upon error the packet ownership is still passed on,
196 	 *	      - Return value less than zero means error, zero or
209 	 *  cttrlcmd() - Control Function upwards in CAIF Stack  (non-blocking).
215 	 *  @ctrl:	Control Command.
217 	void (*ctrlcmd) (struct cflayer *layr, enum caif_ctrlcmd ctrl,
221 	 *  modemctrl() - Control Function used for controlling the modem.
222 	 *  Used to signal down-wards in the CAIF stack.
227 	 *  @ctrl:  Control Command.
229 	int (*modemcmd) (struct cflayer *layr, enum caif_modemcmd ctrl);
236  * layer_set_up() - Set the up pointer for a specified layer.
240 #define layer_set_up(layr, above) ((layr)->up = (struct cflayer *)(above))
243  *  layer_set_dn() - Set the down pointer for a specified layer.
247 #define layer_set_dn(layr, below) ((layr)->dn = (struct cflayer *)(below))
250  * struct dev_info - Physical Device info information about physical layer.
254  *		identify their physical id to Caif MUX (CFMUXL)so
255  *		that the MUX can add the correct physical ID to the
264  * struct caif_payload_info - Payload information embedded in packet (sk_buff).
271  *		Used by mux to insert channel id into the caif packet.