net/caif/cfctrl.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright (C) ST-Ericsson AB 2010
0004  * Author:  Sjur Brendeland
0005  */
0006
0007 #ifndef CFCTRL_H_
0008 #define CFCTRL_H_
0009 #include <net/caif/caif_layer.h>
0010 #include <net/caif/cfsrvl.h>
0011
0012 /* CAIF Control packet commands */
0013 enum cfctrl_cmd {
0014     CFCTRL_CMD_LINK_SETUP = 0,
0015     CFCTRL_CMD_LINK_DESTROY = 1,
0016     CFCTRL_CMD_LINK_ERR = 2,
0017     CFCTRL_CMD_ENUM = 3,
0018     CFCTRL_CMD_SLEEP = 4,
0019     CFCTRL_CMD_WAKE = 5,
0020     CFCTRL_CMD_LINK_RECONF = 6,
0021     CFCTRL_CMD_START_REASON = 7,
0022     CFCTRL_CMD_RADIO_SET = 8,
0023     CFCTRL_CMD_MODEM_SET = 9,
0024     CFCTRL_CMD_MASK = 0xf
0025 };
0026
0027 /* Channel types */
0028 enum cfctrl_srv {
0029     CFCTRL_SRV_DECM = 0,
0030     CFCTRL_SRV_VEI = 1,
0031     CFCTRL_SRV_VIDEO = 2,
0032     CFCTRL_SRV_DBG = 3,
0033     CFCTRL_SRV_DATAGRAM = 4,
0034     CFCTRL_SRV_RFM = 5,
0035     CFCTRL_SRV_UTIL = 6,
0036     CFCTRL_SRV_MASK = 0xf
0037 };
0038
0039 #define CFCTRL_RSP_BIT 0x20
0040 #define CFCTRL_ERR_BIT 0x10
0041
0042 struct cfctrl_rsp {
0043     void (*linksetup_rsp)(struct cflayer *layer, u8 linkid,
0044                   enum cfctrl_srv serv, u8 phyid,
0045                   struct cflayer *adapt_layer);
0046     void (*linkdestroy_rsp)(struct cflayer *layer, u8 linkid);
0047     void (*linkerror_ind)(void);
0048     void (*enum_rsp)(void);
0049     void (*sleep_rsp)(void);
0050     void (*wake_rsp)(void);
0051     void (*restart_rsp)(void);
0052     void (*radioset_rsp)(void);
0053     void (*reject_rsp)(struct cflayer *layer, u8 linkid,
0054                 struct cflayer *client_layer);
0055 };
0056
0057 /* Link Setup Parameters for CAIF-Links. */
0058 struct cfctrl_link_param {
0059     enum cfctrl_srv linktype;/* (T3,T0) Type of Channel */
0060     u8 priority;          /* (P4,P0) Priority of the channel */
0061     u8 phyid;         /* (U2-U0) Physical interface to connect */
0062     u8 endpoint;          /* (E1,E0) Endpoint for data channels */
0063     u8 chtype;        /* (H1,H0) Channel-Type, applies to
0064                    *            VEI, DEBUG */
0065     union {
0066         struct {
0067             u8 connid;  /*  (D7,D0) Video LinkId */
0068         } video;
0069
0070         struct {
0071             u32 connid; /* (N31,Ngit0) Connection ID used
0072                      *  for Datagram */
0073         } datagram;
0074
0075         struct {
0076             u32 connid; /* Connection ID used for RFM */
0077             char volume[20];    /* Volume to mount for RFM */
0078         } rfm;      /* Configuration for RFM */
0079
0080         struct {
0081             u16 fifosize_kb;    /* Psock FIFO size in KB */
0082             u16 fifosize_bufs;  /* Psock # signal buffers */
0083             char name[16];  /* Name of the PSOCK service */
0084             u8 params[255]; /* Link setup Parameters> */
0085             u16 paramlen;   /* Length of Link Setup
0086                          *   Parameters */
0087         } utility;  /* Configuration for Utility Links (Psock) */
0088     } u;
0089 };
0090
0091 /* This structure is used internally in CFCTRL */
0092 struct cfctrl_request_info {
0093     int sequence_no;
0094     enum cfctrl_cmd cmd;
0095     u8 channel_id;
0096     struct cfctrl_link_param param;
0097     struct cflayer *client_layer;
0098     struct list_head list;
0099 };
0100
0101 struct cfctrl {
0102     struct cfsrvl serv;
0103     struct cfctrl_rsp res;
0104     atomic_t req_seq_no;
0105     atomic_t rsp_seq_no;
0106     struct list_head list;
0107     /* Protects from simultaneous access to first_req list */
0108     spinlock_t info_list_lock;
0109 #ifndef CAIF_NO_LOOP
0110     u8 loop_linkid;
0111     int loop_linkused[256];
0112     /* Protects simultaneous access to loop_linkid and loop_linkused */
0113     spinlock_t loop_linkid_lock;
0114 #endif
0115
0116 };
0117
0118 void cfctrl_enum_req(struct cflayer *cfctrl, u8 physlinkid);
0119 int cfctrl_linkup_request(struct cflayer *cfctrl,
0120                struct cfctrl_link_param *param,
0121                struct cflayer *user_layer);
0122 int  cfctrl_linkdown_req(struct cflayer *cfctrl, u8 linkid,
0123              struct cflayer *client);
0124
0125 struct cflayer *cfctrl_create(void);
0126 struct cfctrl_rsp *cfctrl_get_respfuncs(struct cflayer *layer);
0127 int cfctrl_cancel_req(struct cflayer *layr, struct cflayer *adap_layer);
0128 void cfctrl_remove(struct cflayer *layr);
0129
0130 #endif              /* CFCTRL_H_ */