l2cap.h

Go to the documentation of this file.

#ifndef __L2CAP_H__
#define __L2CAP_H__

#include "bt.h"
#include "bd_addr.h"

/* Protocol and service multiplexor */
#define HIDP_PSM        0x0011
#define INTR_PSM        0x0013

/* Packet header lengths */
#define L2CAP_HDR_LEN 4
#define L2CAP_SIGHDR_LEN 4
#define L2CAP_CFGOPTHDR_LEN 2

/* Signals sizes */
#define L2CAP_CONN_REQ_SIZE 4
#define L2CAP_CONN_RSP_SIZE 8
#define L2CAP_CFG_RSP_SIZE 6
#define L2CAP_DISCONN_RSP_SIZE 4

#define L2CAP_CFG_REQ_SIZE 4

#define L2CAP_DISCONN_REQ_SIZE 4
#define L2CAP_CMD_REJ_SIZE 2

/* Signal codes */
#define L2CAP_CMD_REJ 0x01
#define L2CAP_CONN_REQ 0x02
#define L2CAP_CONN_RSP 0x03
#define L2CAP_CFG_REQ 0x04
#define L2CAP_CFG_RSP 0x05
#define L2CAP_DISCONN_REQ 0x06
#define L2CAP_DISCONN_RSP 0x07
#define L2CAP_ECHO_REQ 0x08
#define L2CAP_ECHO_RSP 0x09
#define L2CAP_INFO_REQ 0x0A
#define L2CAP_INFO_RSP 0x0B

/* Permanent channel identifiers */
#define L2CAP_NULL_CID 0x0000
#define L2CAP_SIG_CID 0x0001
#define L2CAP_CONNLESS_CID 0x0002

/* Channel identifiers values */
#define L2CAP_MIN_CID 0x0040
#define L2CAP_MAX_CID 0xFFFF

/* Configuration types */
#define L2CAP_CFG_MTU 0x01
#define L2CAP_FLUSHTO 0x02
#define L2CAP_QOS 0x03

/* Configuration types length */
#define L2CAP_MTU_LEN 2
#define L2CAP_FLUSHTO_LEN 2
#define L2CAP_QOS_LEN 22

/* Configuration response types */
#define L2CAP_CFG_SUCCESS 0x0000
#define L2CAP_CFG_UNACCEPT 0x0001
#define L2CAP_CFG_REJ 0x0002
#define L2CAP_CFG_UNKNOWN 0x0003
#define L2CAP_CFG_TIMEOUT 0xEEEE

/* QoS types */
#define L2CAP_QOS_NO_TRAFFIC 0x00
#define L2CAP_QOS_BEST_EFFORT 0x01
#define L2CAP_QOS_GUARANTEED 0x02

/* Command reject reasons */
#define L2CAP_CMD_NOT_UNDERSTOOD 0x0000
#define L2CAP_MTU_EXCEEDED 0x0001
#define L2CAP_INVALID_CID 0x0002

/* Connection response results */
#define L2CAP_CONN_SUCCESS 0x0000
#define L2CAP_CONN_PND 0x0001
#define L2CAP_CONN_REF_PSM 0x0002
#define L2CAP_CONN_REF_SEC 0x0003
#define L2CAP_CONN_REF_RES 0x0004
#define L2CAP_CONN_CFG_TO 0x0005 /* Implementation specific result */

/* Echo response results */
#define L2CAP_ECHO_RCVD 0x00
#define L2CAP_ECHO_TO 0x01

/* L2CAP segmentation */
#define L2CAP_ACL_START 0x02
#define L2CAP_ACL_CONT 0x01

/* L2CAP config default parameters */
#define L2CAP_CFG_DEFAULT_INMTU 672 /* Two Baseband DH5 packets (2*341=682) minus the Baseband ACL
                       headers (2*2=4) and L2CAP header (6) */
#define L2CAP_CFG_DEFAULT_OUTFLUSHTO 0xFFFF

/* L2CAP configuration parameter masks */
#define L2CAP_CFG_IR 0x01
#define L2CAP_CFG_IN_SUCCESS 0x02
#define L2CAP_CFG_OUT_SUCCESS 0x04
#define L2CAP_CFG_OUT_REQ 0x08

enum l2cap_state {
    L2CAP_CLOSED, L2CAP_LISTEN, W4_L2CAP_CONNECT_RSP, W4_L2CA_CONNECT_RSP, L2CAP_CONFIG,
    L2CAP_OPEN, W4_L2CAP_DISCONNECT_RSP, W4_L2CA_DISCONNECT_RSP
};

struct l2cap_hdr
{
    u16_t len;
    u16_t cid;
} ATTRIBUTE_PACKED;

struct l2cap_sig_hdr
{
    u8_t code;
    u8_t id;
    u16_t len;
} ATTRIBUTE_PACKED;

struct l2cap_cfgopt_hdr
{
    u8_t type;
    u8_t len;
} ATTRIBUTE_PACKED;

/* This structure is used to represent L2CAP signals. */
struct l2cap_sig {
    struct l2cap_sig *next;    /* for the linked list, used when putting signals
                on a queue */
    struct pbuf *p;          /* buffer containing data + L2CAP header */
    u16_t sigid; /* Identification */
    u16_t ertx; /* extended response timeout expired */
    u8_t rtx; /* response timeout expired */
    u8_t nrtx; /* number of retransmissions */
};

struct l2cap_cfg
{
    u16_t inmtu;
    u16_t outmtu;
    u16_t influshto;
    u16_t outflushto;

    struct pbuf *opt;

    u8_t cfgto;
    u8_t l2capcfg;
};

struct l2cap_seg
{
    struct l2cap_seg *next;
    struct bd_addr bdaddr;
    struct pbuf *p;
    u16_t len;
    struct l2cap_hdr *l2caphdr;
    struct l2cap_pcb *pcb; /* The L2CAP Protocol Control Block */
};

struct l2cap_pcb {
    struct l2cap_pcb *next; /* For the linked list */

    enum l2cap_state state; /* L2CAP state */

    void *callback_arg;

    u16_t scid; /* Source CID */
    u16_t dcid; /* Destination CID */

    u16_t psm; /* Protocol/Service Multiplexer */

    u16_t ursp_id; /* Signal id to respond to */
    u8_t encrypt; /* encryption mode */

    struct l2cap_sig *unrsp_sigs;  /* List of sent but unresponded signals */

    struct bd_addr remote_bdaddr;

    struct l2cap_cfg cfg; /* Configuration parameters */

    /* Upper layer to L2CAP confirmation functions */

    /* Function to be called when a connection has been set up */
    err_t (* l2ca_connect_cfm)(void *arg, struct l2cap_pcb *pcb, u16_t result, u16_t status);
    /* Function to be called when a connection has been closed */
    err_t (* l2ca_disconnect_cfm)(void *arg, struct l2cap_pcb *pcb);
    /* Function to be called when a echo reply has been received */
    err_t (* l2ca_pong)(void *arg, struct l2cap_pcb *pcb, u8_t result);

    /* L2CAP to upper layer indication functions */

    /* Function to be called when a connection indication event occurs */
    err_t (* l2ca_connect_ind)(void *arg, struct l2cap_pcb *pcb, err_t err);
    /* Function to be called when a disconnection indication event occurs */
    err_t (* l2ca_disconnect_ind)(void *arg, struct l2cap_pcb *pcb, err_t err);
    /* Function to be called when a timeout indication event occurs */
    err_t (* l2ca_timeout_ind)(void *arg, struct l2cap_pcb *newpcb, err_t err);
    /* Function to be called when a L2CAP connection receives data */
    err_t (* l2ca_recv)(void *arg, struct l2cap_pcb *pcb, struct pbuf *p, err_t err);
};

struct l2cap_pcb_listen {
    struct l2cap_pcb_listen *next; /* for the linked list */

    enum l2cap_state state; /* L2CAP state */

    void *callback_arg;

    u16_t psm; /* Protocol/Service Multiplexer */
    struct bd_addr bdaddr;      /* Device Address */

    /* Function to call when a connection request has been received
     from a remote device. */
    err_t (* l2ca_connect_ind)(void *arg, struct l2cap_pcb *pcb, err_t err);
};

#define l2cap_psm(pcb) ((pcb)->psm)

void l2cap_init();
struct l2cap_pcb* l2cap_new(void);

void lp_connect_ind(struct bd_addr *bdaddr);
void lp_connect_cfm(struct bd_addr *bdaddr, u8_t encrypt_mode, err_t err);
void lp_disconnect_ind(struct bd_addr *bdaddr,u8_t reason);

err_t l2ca_config_req(struct l2cap_pcb *pcb);
err_t l2ca_disconnect_req(struct l2cap_pcb *pcb, err_t (* l2ca_disconnect_cfm)(void *arg, struct l2cap_pcb *pcb));
err_t l2ca_datawrite(struct l2cap_pcb *pcb, struct pbuf *p);
err_t l2ca_ping(struct bd_addr *bdaddr, struct l2cap_pcb *tpcb,err_t (* l2ca_pong)(void *arg, struct l2cap_pcb *pcb, u8_t result));
err_t l2ca_connect_req(struct l2cap_pcb *pcb, struct bd_addr *bdaddr, u16_t psm, u8_t role_switch, err_t (* l2ca_connect_cfm)(void *arg, struct l2cap_pcb *lpcb,u16_t result, u16_t status));

void l2cap_tmr();
void l2cap_input(struct pbuf *p, struct bd_addr *bdaddr);
err_t l2cap_close(struct l2cap_pcb *pcb);
void l2cap_reset_all(void);
u8_t l2cap_next_sigid(void);
err_t l2cap_write(struct bd_addr *bdaddr, struct pbuf *p, u16_t len);
void l2cap_arg(struct l2cap_pcb *pcb, void *arg);
void l2cap_disconnect_ind(struct l2cap_pcb *pcb, err_t (* l2ca_disconnect_ind)(void *arg, struct l2cap_pcb *newpcb, err_t err));
void l2cap_timeout_ind(struct l2cap_pcb *pcb,err_t (* l2ca_timeout_ind)(void *arg, struct l2cap_pcb *newpcb, err_t err));
void l2cap_recv(struct l2cap_pcb *pcb, err_t (* l2ca_recv)(void *arg, struct l2cap_pcb *pcb, struct pbuf *p, err_t err));
err_t l2cap_signal(struct l2cap_pcb *pcb, u8_t code, u16_t ursp_id, struct bd_addr *remote_bdaddr, struct pbuf *data);
void l2cap_process_sig(struct pbuf *q, struct l2cap_hdr *l2caphdr, struct bd_addr *bdaddr);

err_t l2cap_rexmit_signal(struct l2cap_pcb *pcb, struct l2cap_sig *sig);
err_t l2cap_connect_ind(struct l2cap_pcb *npcb, struct bd_addr *bdaddr, u16_t psm,err_t (* l2ca_connect_ind)(void *arg, struct l2cap_pcb *pcb, err_t err));

void (*l2cap_disconnect_bb(void (*l2ca_disconnect_bb)(struct bd_addr *bdaddr,u8_t reason)))(struct bd_addr *bdaddr,u8_t reason);

/* Internal functions and global variables */
#define L2CA_ACTION_CONN_CFM(pcb,result,status,ret) if((pcb)->l2ca_connect_cfm != NULL) (ret = (pcb)->l2ca_connect_cfm((pcb)->callback_arg,(pcb),(result),(status)))
#define L2CA_ACTION_DISCONN_CFM(pcb,ret) if((pcb)->l2ca_disconnect_cfm != NULL) (ret = (pcb)->l2ca_disconnect_cfm((pcb)->callback_arg,(pcb)))
#define L2CA_ACTION_PING_CFM(pcb,result,ret) if((pcb)->l2ca_pong != NULL) (ret = (pcb)->l2ca_pong((pcb)->callback_arg,(pcb),(result)))

#define L2CA_ACTION_CONN_IND(pcb,err,ret) if((pcb)->l2ca_connect_ind != NULL) (ret = (pcb)->l2ca_connect_ind((pcb)->callback_arg,(pcb),(err)))
#define L2CA_ACTION_DISCONN_IND(pcb,err,ret) \
                                if((pcb)->l2ca_disconnect_ind != NULL) { \
                                LOG("l2cap_disconnect_ind called\n"); \
                                (ret = (pcb)->l2ca_disconnect_ind((pcb)->callback_arg,(pcb),(err))); \
                                } else { \
                                l2cap_close(pcb); \
                                }
#define L2CA_ACTION_TO_IND(pcb,err,ret) if((pcb)->l2ca_timeout_ind != NULL) (ret = (pcb)->l2ca_timeout_ind((pcb)->callback_arg,(pcb),(err)))
#define L2CA_ACTION_RECV(pcb,p,err,ret) \
                         if((pcb)->l2ca_recv != NULL) { \
             (ret = (pcb)->l2ca_recv((pcb)->callback_arg,(pcb),(p),(err))); \
             } else { \
             btpbuf_free(p); \
                         }

#define L2CAP_OPTH_TYPE(hdr) (((hdr)->type) & 0x7f)
#define L2CAP_OPTH_TOA(hdr) (((hdr)->type) >> 7)

/* The L2CAP PCB lists. */
extern struct l2cap_pcb_listen *l2cap_listen_pcbs; /* List of all L2CAP PCBs in CLOSED state
                        but awaing an incoming conn req. */
extern struct l2cap_pcb *l2cap_active_pcbs; /* List of all L2CAP PCBs that has
                           established or is about to establish
                           an ACL link */

extern struct l2cap_pcb *l2cap_tmp_pcb;      /* Only used for temporary storage. */

#define L2CAP_REG(pcbs, npcb) do { \
                            u32 level; \
                            _CPU_ISR_Disable(level); \
                            npcb->next = *pcbs; \
                            *pcbs = npcb; \
                            _CPU_ISR_Restore(level); \
                            } while(0)
#define L2CAP_RMV(pcbs, npcb) do { \
                            u32 level; \
                            _CPU_ISR_Disable(level); \
                            if(*pcbs == npcb) { \
                               *pcbs = (*pcbs)->next; \
                            } else for(l2cap_tmp_pcb = *pcbs; l2cap_tmp_pcb != NULL; l2cap_tmp_pcb = l2cap_tmp_pcb->next) { \
                               if(l2cap_tmp_pcb->next != NULL && l2cap_tmp_pcb->next == npcb) { \
                                  l2cap_tmp_pcb->next = npcb->next; \
                                  break; \
                               } \
                            } \
                            npcb->next = NULL; \
                            _CPU_ISR_Restore(level); \
                            } while(0)

/* The L2CAP SIG list macros */
extern struct l2cap_sig *l2cap_tmp_sig;      /* Only used for temporary storage. */

#define L2CAP_SIG_REG(ursp_sigs, nsig) do { \
                            u32 level; \
                            _CPU_ISR_Disable(level); \
                            nsig->next = *ursp_sigs; \
                            *ursp_sigs = nsig; \
                            _CPU_ISR_Restore(level); \
                            } while(0)
#define L2CAP_SIG_RMV(ursp_sigs, nsig) do { \
                            u32 level; \
                            _CPU_ISR_Disable(level); \
                            if(*ursp_sigs == nsig) { \
                               *ursp_sigs = (*ursp_sigs)->next; \
                            } else for(l2cap_tmp_sig = *ursp_sigs; l2cap_tmp_sig != NULL; l2cap_tmp_sig = l2cap_tmp_sig->next) { \
                               if(l2cap_tmp_sig->next != NULL && l2cap_tmp_sig->next == nsig) { \
                                  l2cap_tmp_sig->next = nsig->next; \
                                  break; \
                               } \
                            } \
                            nsig->next = NULL; \
                            _CPU_ISR_Restore(level); \
                            } while(0)

/* The L2CAP incoming segments list macros */
extern struct l2cap_seg *l2cap_tmp_inseg;      /* Only used for temporary storage. */

#define L2CAP_SEG_REG(segs, nseg) do { \
                            u32 level; \
                            _CPU_ISR_Disable(level); \
                            nseg->next = *segs; \
                            *segs = nseg; \
                            _CPU_ISR_Restore(level); \
                            } while(0)
#define L2CAP_SEG_RMV(segs, nseg) do { \
                            u32 level; \
                            _CPU_ISR_Disable(level); \
                            if(*segs == nseg) { \
                               *segs = (*segs)->next; \
                            } else for(l2cap_tmp_inseg = *segs; l2cap_tmp_inseg != NULL; l2cap_tmp_inseg = l2cap_tmp_inseg->next) { \
                               if(l2cap_tmp_inseg->next != NULL && l2cap_tmp_inseg->next == nseg) { \
                                  l2cap_tmp_inseg->next = nseg->next; \
                                  break; \
                               } \
                            } \
                            nseg->next = NULL; \
                            _CPU_ISR_Restore(level); \
                            } while(0)

#endif