caif_dev.h File Reference

#include <net/caif/caif_layer.h>
#include <net/caif/cfcnfg.h>
#include <net/caif/caif_device.h>
#include <linux/caif/caif_socket.h>
#include <linux/if.h>
#include <linux/net.h>

Go to the source code of this file.

Data Structures
struct	caif_param
struct	caif_connect_request

Functions
int	caif_connect_client (struct net *net, struct caif_connect_request *conn_req, struct cflayer *client_layer, int *ifindex, int *headroom, int *tailroom)
int	caif_disconnect_client (struct net *net, struct cflayer *client_layer)
void	caif_client_register_refcnt (struct cflayer *adapt_layer, void(*hold)(struct cflayer *lyr), void(*put)(struct cflayer *lyr))
void	caif_free_client (struct cflayer *adap_layer)
void	caif_enroll_dev (struct net_device *dev, struct caif_dev_common *caifdev, struct cflayer *link_support, int head_room, struct cflayer **layer, int(**rcv_func)(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *))

Function Documentation

void caif_client_register_refcnt	(	struct cflayer *	adapt_layer,
		void(*)(struct cflayer *lyr)	hold,
		void(*)(struct cflayer *lyr)	put
	)

caif_client_register_refcnt - register ref-count functions provided by client.

: Client layer using CAIF Stack. : Function provided by client layer increasing ref-count : Function provided by client layer decreasing ref-count

Client of the CAIF Stack must register functions for reference counting. These functions are called by the CAIF Stack for every upstream packet, and must therefore be implemented efficiently.

Client should call caif_free_client when reference count degrease to zero.

Definition at line 209 of file cfsrvl.c.

int caif_connect_client	(	struct net *	net,
		struct caif_connect_request *	conn_req,
		struct cflayer *	client_layer,
		int *	ifindex,
		int *	headroom,
		int *	tailroom
	)

caif_connect_client - Connect a client to CAIF Core Stack. : Channel setup parameters, specifying what address to connect on the Modem. : User implementation of client layer. This layer MUST have receive and control callback functions implemented. : Link layer interface index used for this connection. : Head room needed by CAIF protocol. : Tail room needed by CAIF protocol.

This function connects a CAIF channel. The Client must implement the struct cflayer. This layer represents the Client layer and holds receive functions and control callback functions. Control callback function will receive information about connect/disconnect responses, flow control etc (see enum caif_control). E.g. CAIF Socket will call this function for each socket it connects and have one client_layer instance for each socket.

Definition at line 302 of file cfcnfg.c.

int caif_disconnect_client	(	struct net *	net,
		struct cflayer *	client_layer
	)

caif_disconnect_client - Disconnects a client from the CAIF stack.

: Client layer to be disconnected.

Definition at line 179 of file cfcnfg.c.

void caif_enroll_dev	(	struct net_device *	dev,
		struct caif_dev_common *	caifdev,
		struct cflayer *	link_support,
		int	head_room,
		struct cflayer **	layer,
		int(**)(struct sk_buff *, struct net_device *, struct packet_type *, struct net_device *)	rcv_func
	)

struct caif_enroll_dev - Enroll a net-device as a CAIF Link layer : Network device to enroll. : Configuration information from CAIF Link Layer : Link layer support layer : Head room needed by link support layer : Lowest layer in CAIF stack : Receive function for CAIF stack.

This function enroll a CAIF link layer into CAIF Stack and expects the interface to be able to handle CAIF payload. The link_support layer is used to add any Link Layer specific framing.

Definition at line 303 of file caif_dev.c.

void caif_free_client

(

struct cflayer *

adap_layer

)

caif_free_client - Free memory used to manage the client in the CAIF Stack.

: Client layer to be removed.

This function must be called from client layer in order to free memory. Caller must guarantee that no packets are in flight upstream when calling this function.

Definition at line 199 of file cfsrvl.c.