lapd_core.h

Go to the documentation of this file.

 
#pragma once
 
#include <stdint.h>
 
#include <osmocom/core/timer.h>
#include <osmocom/core/msgb.h>
#include <osmocom/gsm/prim.h>
 
#define LOGDL(dl, level, fmt, args...) \
        LOGP(DLLAPD, level, "(%s) "  fmt, (dl)->name, ## args)
 
enum osmo_dl_prim {
        PRIM_DL_UNIT_DATA,      
        PRIM_DL_DATA,           
        PRIM_DL_EST,            
        PRIM_DL_REL,            
        PRIM_DL_SUSP,           
        PRIM_DL_RES,            
        PRIM_DL_RECON,          
        PRIM_MDL_ERROR,         
};
 
/* Uses the same values as RLL, so no conversion for GSM is required. */
#define MDL_CAUSE_T200_EXPIRED          0x01
#define MDL_CAUSE_REEST_REQ             0x02
#define MDL_CAUSE_UNSOL_UA_RESP         0x03
#define MDL_CAUSE_UNSOL_DM_RESP         0x04
#define MDL_CAUSE_UNSOL_DM_RESP_MF      0x05
#define MDL_CAUSE_UNSOL_SPRV_RESP       0x06
#define MDL_CAUSE_SEQ_ERR               0x07
#define MDL_CAUSE_UFRM_INC_PARAM        0x08
#define MDL_CAUSE_SFRM_INC_PARAM        0x09
#define MDL_CAUSE_IFRM_INC_MBITS        0x0a
#define MDL_CAUSE_IFRM_INC_LEN          0x0b
#define MDL_CAUSE_FRM_UNIMPL            0x0c
#define MDL_CAUSE_SABM_MF               0x0d
#define MDL_CAUSE_SABM_INFO_NOTALL      0x0e
#define MDL_CAUSE_FRMR                  0x0f
 
struct mdl_error_ind_param {
        uint8_t cause;          
};
 
struct dl_rel_req_param {
        uint8_t mode;           
};
 
struct osmo_dlsap_prim {
        struct osmo_prim_hdr oph; 
        union {
                struct mdl_error_ind_param error_ind;
                struct dl_rel_req_param rel_req;
        } u;                    
};
 
enum lapd_mode {
        LAPD_MODE_USER,         
        LAPD_MODE_NETWORK,      
};
 
enum lapd_state {
        LAPD_STATE_NULL = 0,
        LAPD_STATE_TEI_UNASS,
        LAPD_STATE_ASS_TEI_WAIT,
        LAPD_STATE_EST_TEI_WAIT,
        LAPD_STATE_IDLE,
        LAPD_STATE_SABM_SENT,
        LAPD_STATE_DISC_SENT,
        LAPD_STATE_MF_EST,
        LAPD_STATE_TIMER_RECOV,
};
 
#define LAPD_F_RTS              0x0001
#define LAPD_F_DROP_2ND_REJ     0x0002
 
enum lapd_t200_rts {
        LAPD_T200_RTS_OFF = 0,
        LAPD_T200_RTS_PENDING,
        LAPD_T200_RTS_RUNNING,
};
 
enum lapd_format {
        LAPD_FORM_UKN = 0,
        LAPD_FORM_I,
        LAPD_FORM_S,
        LAPD_FORM_U,
};
 
struct lapd_msg_ctx {
        struct lapd_datalink *dl;
        int n201;
        /* address */
        uint8_t cr;
        uint8_t sapi;
        uint8_t tei;
        uint8_t lpd;
        /* control */
        uint8_t format;
        uint8_t p_f; /* poll / final bit */
        uint8_t n_send;
        uint8_t n_recv;
        uint8_t s_u; /* S or repectivly U function bits */
        /* length */
        int     length;
        uint8_t more;
};
 
struct lapd_cr_ent {
        uint8_t cmd;
        uint8_t resp;
};
 
struct lapd_history {
        struct msgb *msg; /* message to be sent / NULL, if histoy is empty */
        int     more; /* if message is fragmented */
};
 
struct lapd_datalink {
        int (*send_dlsap)(struct osmo_dlsap_prim *dp, struct lapd_msg_ctx *lctx);
        int (*send_ph_data_req)(struct lapd_msg_ctx *lctx, struct msgb *msg);
        int (*update_pending_frames)(struct lapd_msg_ctx *lctx);
        struct {
                struct lapd_cr_ent loc2rem;
                struct lapd_cr_ent rem2loc;
        } cr;
        enum lapd_mode mode; 
        unsigned int lapd_flags; 
        int use_sabme; 
        int reestablish; 
        int n200, n200_est_rel; 
        struct lapd_msg_ctx lctx; 
        int maxf; 
        uint8_t k; 
        uint8_t v_range; 
        uint8_t v_send; 
        uint8_t v_ack;  
        uint8_t v_recv; 
        uint32_t state; 
        int seq_err_cond; 
        uint8_t own_busy; 
        uint8_t peer_busy; 
        int t200_sec, t200_usec; 
        int t203_sec, t203_usec; 
        enum lapd_t200_rts t200_rts; 
        struct osmo_timer_list t200; 
        struct osmo_timer_list t203; 
        uint8_t retrans_ctr; 
        struct llist_head tx_queue; 
        struct llist_head send_queue; 
        struct msgb *send_buffer; 
        int send_out; 
        struct lapd_history *tx_hist; 
        uint8_t range_hist; 
        struct msgb *rcv_buffer; 
        struct msgb *cont_res; 
        char *name; 
};
 
void lapd_dl_init(struct lapd_datalink *dl, uint8_t k, uint8_t v_range, int maxf)
        OSMO_DEPRECATED("Use lapd_dl_init2() instead");
void lapd_dl_init2(struct lapd_datalink *dl, uint8_t k, uint8_t v_range, int maxf, const char *name);
void lapd_dl_set_name(struct lapd_datalink *dl, const char *name);
void lapd_dl_exit(struct lapd_datalink *dl);
void lapd_dl_reset(struct lapd_datalink *dl);
int lapd_dl_set_flags(struct lapd_datalink *dl, unsigned int flags);
int lapd_set_mode(struct lapd_datalink *dl, enum lapd_mode mode);
int lapd_ph_data_ind(struct msgb *msg, struct lapd_msg_ctx *lctx);
int lapd_ph_rts_ind(struct lapd_msg_ctx *lctx);
int lapd_recv_dlsap(struct osmo_dlsap_prim *dp, struct lapd_msg_ctx *lctx);
int lapd_t200_timeout(struct lapd_datalink *dl);