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>
19  * caif_assert() - Assert function for CAIF.
34  * enum caif_ctrlcmd - CAIF Stack Control Signaling sent in layer.ctrlcmd().
48  * @CAIF_CTRLCMD_DEINIT_RSP:		Called when de-initialization is
77  * enum caif_modemcmd -	 Modem Control Signaling, sent from CAIF Client
102  * enum caif_direction - CAIF Packet Direction.
113  * struct cflayer - CAIF Stack layer.
117  * @node:	List node used when layer participate in a list.
135  *    - All layers must use this structure. If embedding it, then place this
138  *    - Each layer should not depend on any others layer's private data.
140  *    - In order to send data upwards do
141  *	layer->up->receive(layer->up, packet);
143  *    - In order to send data downwards do
144  *	layer->dn->transmit(layer->dn, info, packet);
152 	 *  receive() - Receive Function (non-blocking).
156 	 *	      - The CAIF packet (cfpkt) ownership is passed to the
159 	 *		above layer using up->receive().
161 	 *	      - If parsing of the packet fails, the packet must be
165 	 *			-EILSEQ, the packet is not freed.
167 	 *	      - If parsing succeeds (and above layers return OK) then
180 	 *  transmit() - Transmit Function (non-blocking).
184 	 *	      - The CAIF packet (cfpkt) ownership is passed to the
187 	 *		layer using dn->transmit().
189 	 *	      - Upon error the packet ownership is still passed on,
194 	 *	      - Return value less than zero means error, zero or
207 	 *  cttrlcmd() - Control Function upwards in CAIF Stack  (non-blocking).
213 	 *  @ctrl:	Control Command.
215 	void (*ctrlcmd) (struct cflayer *layr, enum caif_ctrlcmd ctrl,
219 	 *  modemctrl() - Control Function used for controlling the modem.
220 	 *  Used to signal down-wards in the CAIF stack.
225 	 *  @ctrl:  Control Command.
227 	int (*modemcmd) (struct cflayer *layr, enum caif_modemcmd ctrl);
234  * layer_set_up() - Set the up pointer for a specified layer.
238 #define layer_set_up(layr, above) ((layr)->up = (struct cflayer *)(above))
241  *  layer_set_dn() - Set the down pointer for a specified layer.
245 #define layer_set_dn(layr, below) ((layr)->dn = (struct cflayer *)(below))
248  * struct dev_info - Physical Device info information about physical layer.
252  *		identify their physical id to Caif MUX (CFMUXL)so
253  *		that the MUX can add the correct physical ID to the
262  * struct caif_payload_info - Payload information embedded in packet (sk_buff).
269  *		Used by mux to insert channel id into the caif packet.