Home | History | Annotate | Download | only in include
      1 /******************************************************************************
      2  *
      3  *  Copyright 1999-2012 Broadcom Corporation
      4  *
      5  *  Licensed under the Apache License, Version 2.0 (the "License");
      6  *  you may not use this file except in compliance with the License.
      7  *  You may obtain a copy of the License at:
      8  *
      9  *  http://www.apache.org/licenses/LICENSE-2.0
     10  *
     11  *  Unless required by applicable law or agreed to in writing, software
     12  *  distributed under the License is distributed on an "AS IS" BASIS,
     13  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     14  *  See the License for the specific language governing permissions and
     15  *  limitations under the License.
     16  *
     17  ******************************************************************************/
     18 
     19 /****************************************************************************
     20  *
     21  *  This file contains definitions for the RFCOMM protocol
     22  *
     23  ****************************************************************************/
     24 
     25 #ifndef RFCDEFS_H
     26 #define RFCDEFS_H
     27 
     28 #define PORT_MAX_RFC_PORTS 31
     29 
     30 /*
     31  *  If nothing is negotiated MTU should be 127
     32 */
     33 #define RFCOMM_DEFAULT_MTU 127
     34 
     35 /*
     36  * Define used by RFCOMM TS frame types
     37 */
     38 #define RFCOMM_SABME 0x2F
     39 #define RFCOMM_UA 0x63
     40 #define RFCOMM_DM 0x0F
     41 #define RFCOMM_DISC 0x43
     42 #define RFCOMM_UIH 0xEF
     43 
     44 /*
     45  * Defenitions for the TS control frames
     46 */
     47 #define RFCOMM_CTRL_FRAME_LEN 3
     48 #define RFCOMM_MIN_OFFSET 5 /* ctrl 2 , len 1 or 2 bytes, credit 1 byte */
     49 #define RFCOMM_DATA_OVERHEAD (RFCOMM_MIN_OFFSET + 1) /* add 1 for checksum */
     50 
     51 #define RFCOMM_EA 1
     52 #define RFCOMM_EA_MASK 0x01
     53 #define RFCOMM_CR_MASK 0x02
     54 #define RFCOMM_SHIFT_CR 1
     55 #define RFCOMM_SHIFT_DLCI 2
     56 #define RFCOMM_SHIFT_DLCI2 6
     57 #define RFCOMM_PF 0x10
     58 #define RFCOMM_PF_MASK 0x10
     59 #define RFCOMM_PF_OFFSET 4
     60 #define RFCOMM_SHIFT_LENGTH1 1
     61 #define RFCOMM_SHIFT_LENGTH2 7
     62 #define RFCOMM_SHIFT_MX_CTRL_TYPE 2
     63 
     64 #define RFCOMM_INITIATOR_CMD 1
     65 #define RFCOMM_INITIATOR_RSP 0
     66 #define RFCOMM_RESPONDER_CMD 0
     67 #define RFCOMM_RESPONDER_RSP 1
     68 
     69 #define RFCOMM_PARSE_CTRL_FIELD(ea, cr, dlci, p_data)       \
     70   {                                                         \
     71     (ea) = *(p_data)&RFCOMM_EA;                             \
     72     (cr) = (*(p_data)&RFCOMM_CR_MASK) >> RFCOMM_SHIFT_CR;   \
     73     (dlci) = *(p_data)++ >> RFCOMM_SHIFT_DLCI;              \
     74     if (!(ea)) (dlci) += *(p_data)++ << RFCOMM_SHIFT_DLCI2; \
     75   }
     76 
     77 #define RFCOMM_FORMAT_CTRL_FIELD(p_data, ea, cr, dlci) \
     78   (*(p_data)++ = (ea) | (cr) | ((dlci) << RFCOMM_SHIFT_DLCI))
     79 
     80 #define RFCOMM_PARSE_TYPE_FIELD(type, pf, p_data)              \
     81   {                                                            \
     82     (type) = *(p_data) & ~RFCOMM_PF_MASK;                      \
     83     (pf) = (*(p_data)++ & RFCOMM_PF_MASK) >> RFCOMM_PF_OFFSET; \
     84   }
     85 
     86 #define RFCOMM_FORMAT_TYPE_FIELD(p_data, type, pf)             \
     87   *(p_data)++ = ((type) | ((pf) << RFCOMM_PF_OFFSET)) {        \
     88     (type) = *(p_data) & ~RFCOMM_PF_MASK;                      \
     89     (pf) = (*(p_data)++ & RFCOMM_PF_MASK) >> RFCOMM_PF_OFFSET; \
     90   }
     91 
     92 #define RFCOMM_PARSE_LEN_FIELD(ea, length, p_data)                \
     93   {                                                               \
     94     (ea) = (*(p_data)&RFCOMM_EA);                                 \
     95     (length) = (*(p_data)++ >> RFCOMM_SHIFT_LENGTH1);             \
     96     if (!(ea)) (length) += (*(p_data)++ << RFCOMM_SHIFT_LENGTH2); \
     97   }
     98 
     99 #define RFCOMM_FRAME_IS_CMD(initiator, cr) \
    100   (((initiator) && !(cr)) || (!(initiator) && (cr)))
    101 
    102 #define RFCOMM_FRAME_IS_RSP(initiator, cr) \
    103   (((initiator) && (cr)) || (!(initiator) && !(cr)))
    104 
    105 #define RFCOMM_CR(initiator, is_command) \
    106   ((((initiator) && (is_command)) || (!(initiator) && !(is_command))) << 1)
    107 
    108 #define RFCOMM_I_CR(is_command) ((is_command) ? 0x02 : 0x00)
    109 
    110 #define RFCOMM_MAX_DLCI 61
    111 
    112 #define RFCOMM_VALID_DLCI(dlci) \
    113   (((dlci) == 0) || (((dlci) >= 2) && ((dlci) <= RFCOMM_MAX_DLCI)))
    114 
    115 /* Port Negotiation (PN) */
    116 #define RFCOMM_PN_DLCI_MASK 0x3F
    117 
    118 #define RFCOMM_PN_FRAM_TYPE_UIH 0x00
    119 #define RFCOMM_PN_FRAME_TYPE_MASK 0x0F
    120 
    121 #define RFCOMM_PN_CONV_LAYER_MASK 0xF0
    122 #define RFCOMM_PN_CONV_LAYER_TYPE_1 0
    123 #define RFCOMM_PN_CONV_LAYER_CBFC_I 0xF0
    124 #define RFCOMM_PN_CONV_LAYER_CBFC_R 0xE0
    125 
    126 #define RFCOMM_PN_PRIORITY_MASK 0x3F
    127 #define RFCOMM_PN_PRIORITY_0 0
    128 
    129 #define RFCOMM_PN_K_MASK 0x07
    130 
    131 #define RFCOMM_T1_DSEC 0 /* None negotiable in RFCOMM */
    132 #define RFCOMM_N2 0      /* Number of retransmissions */
    133 #define RFCOMM_K 0       /* Window size */
    134 #define RFCOMM_K_MAX 7   /* Max value of K for credit based flow control */
    135 
    136 #define RFCOMM_MSC_FC 0x02  /* Flow control*/
    137 #define RFCOMM_MSC_RTC 0x04 /* Ready to communicate*/
    138 #define RFCOMM_MSC_RTR 0x08 /* Ready to receive*/
    139 #define RFCOMM_MSC_IC 0x40  /* Incomming call indicator*/
    140 #define RFCOMM_MSC_DV 0x80  /* Data Valid*/
    141 
    142 #define RFCOMM_MSC_SHIFT_BREAK 4
    143 #define RFCOMM_MSC_BREAK_MASK 0xF0
    144 #define RFCOMM_MSC_BREAK_PRESENT_MASK 0x02
    145 
    146 #define RFCOMM_BAUD_RATE_2400 0x00
    147 #define RFCOMM_BAUD_RATE_4800 0x01
    148 #define RFCOMM_BAUD_RATE_7200 0x02
    149 #define RFCOMM_BAUD_RATE_9600 0x03
    150 #define RFCOMM_BAUD_RATE_19200 0x04
    151 #define RFCOMM_BAUD_RATE_38400 0x05
    152 #define RFCOMM_BAUD_RATE_57600 0x06
    153 #define RFCOMM_BAUD_RATE_115200 0x07
    154 #define RFCOMM_BAUD_RATE_230400 0x08
    155 
    156 #define RFCOMM_5_BITS 0x00
    157 #define RFCOMM_6_BITS 0x01
    158 #define RFCOMM_7_BITS 0x02
    159 #define RFCOMM_8_BITS 0x03
    160 
    161 #define RFCOMM_RPN_BITS_MASK 0x03
    162 #define RFCOMM_RPN_BITS_SHIFT 0
    163 
    164 #define RFCOMM_ONESTOPBIT 0x00
    165 #define RFCOMM_ONE5STOPBITS 0x01
    166 
    167 #define RFCOMM_RPN_STOP_BITS_MASK 0x01
    168 #define RFCOMM_RPN_STOP_BITS_SHIFT 2
    169 
    170 #define RFCOMM_PARITY_NO 0x00
    171 #define RFCOMM_PARITY_YES 0x01
    172 #define RFCOMM_RPN_PARITY_MASK 0x01
    173 #define RFCOMM_RPN_PARITY_SHIFT 3
    174 
    175 #define RFCOMM_ODD_PARITY 0x00
    176 #define RFCOMM_EVEN_PARITY 0x01
    177 #define RFCOMM_MARK_PARITY 0x02
    178 #define RFCOMM_SPACE_PARITY 0x03
    179 
    180 #define RFCOMM_RPN_PARITY_TYPE_MASK 0x03
    181 #define RFCOMM_RPN_PARITY_TYPE_SHIFT 4
    182 
    183 #define RFCOMM_FC_OFF 0x00
    184 #define RFCOMM_FC_XONXOFF_ON_INPUT 0x01
    185 #define RFCOMM_FC_XONXOFF_ON_OUTPUT 0x02
    186 #define RFCOMM_FC_RTR_ON_INPUT 0x04
    187 #define RFCOMM_FC_RTR_ON_OUTPUT 0x08
    188 #define RFCOMM_FC_RTC_ON_INPUT 0x10
    189 #define RFCOMM_FC_RTC_ON_OUTPUT 0x20
    190 #define RFCOMM_FC_MASK 0x3F
    191 
    192 #define RFCOMM_RPN_PM_BIT_RATE 0x0001
    193 #define RFCOMM_RPN_PM_DATA_BITS 0x0002
    194 #define RFCOMM_RPN_PM_STOP_BITS 0x0004
    195 #define RFCOMM_RPN_PM_PARITY 0x0008
    196 #define RFCOMM_RPN_PM_PARITY_TYPE 0x0010
    197 #define RFCOMM_RPN_PM_XON_CHAR 0x0020
    198 #define RFCOMM_RPN_PM_XOFF_CHAR 0x0040
    199 #define RFCOMM_RPN_PM_XONXOFF_ON_INPUT 0x0100
    200 #define RFCOMM_RPN_PM_XONXOFF_ON_OUTPUT 0x0200
    201 #define RFCOMM_RPN_PM_RTR_ON_INPUT 0x0400
    202 #define RFCOMM_RPN_PM_RTR_ON_OUTPUT 0x0800
    203 #define RFCOMM_RPN_PM_RTC_ON_INPUT 0x1000
    204 #define RFCOMM_RPN_PM_RTC_ON_OUTPUT 0x2000
    205 #define RFCOMM_RPN_PM_MASK 0x3F7F
    206 
    207 #define RFCOMM_RLS_ERROR 0x01
    208 #define RFCOMM_RLS_OVERRUN 0x02
    209 #define RFCOMM_RLS_PARITY 0x04
    210 #define RFCOMM_RLS_FRAMING 0x08
    211 
    212 /* Multiplexor channel uses DLCI 0 */
    213 #define RFCOMM_MX_DLCI 0
    214 
    215 /*
    216  * Define RFCOMM Multiplexer message types
    217 */
    218 #define RFCOMM_MX_PN 0x80
    219 #define RFCOMM_MX_PN_LEN 8
    220 
    221 #define RFCOMM_MX_CLD 0xC0
    222 #define RFCOMM_MX_CLD_LEN 0
    223 
    224 #define RFCOMM_MX_TEST 0x20
    225 
    226 #define RFCOMM_MX_FCON 0xA0
    227 #define RFCOMM_MX_FCON_LEN 0
    228 
    229 #define RFCOMM_MX_FCOFF 0x60
    230 #define RFCOMM_MX_FCOFF_LEN 0
    231 
    232 #define RFCOMM_MX_MSC 0xE0
    233 #define RFCOMM_MX_MSC_LEN_NO_BREAK 2
    234 #define RFCOMM_MX_MSC_LEN_WITH_BREAK 3
    235 
    236 #define RFCOMM_MX_NSC 0x10
    237 #define RFCOMM_MX_NSC_LEN 1
    238 
    239 #define RFCOMM_MX_RPN 0x90
    240 #define RFCOMM_MX_RPN_REQ_LEN 1
    241 #define RFCOMM_MX_RPN_LEN 8
    242 
    243 #define RFCOMM_MX_RLS 0x50
    244 #define RFCOMM_MX_RLS_LEN 2
    245 #endif
    246