Home | History | Annotate | Download | only in include
      1 /******************************************************************************
      2  *
      3  *  Copyright (C) 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 {                                                           \
     89     type = *p_data & ~RFCOMM_PF_MASK;                       \
     90     pf   = (*p_data++ & RFCOMM_PF_MASK) >> RFCOMM_PF_OFFSET;\
     91 }
     92 
     93 #define RFCOMM_PARSE_LEN_FIELD(ea, length, p_data)          \
     94 {                                                           \
     95     ea = (*p_data & RFCOMM_EA);                             \
     96     length = (*p_data++ >> RFCOMM_SHIFT_LENGTH1);           \
     97     if (!ea) length += (*p_data++ << RFCOMM_SHIFT_LENGTH2); \
     98 }
     99 
    100 #define RFCOMM_FRAME_IS_CMD(initiator, cr)                  \
    101     (( (initiator) && !(cr)) || (!(initiator) &&  (cr)))
    102 
    103 #define RFCOMM_FRAME_IS_RSP(initiator, cr)                  \
    104     (( (initiator) &&  (cr)) || (!(initiator) && !(cr)))
    105 
    106 #define RFCOMM_CR(initiator, is_command)                    \
    107     (( ( (initiator) &&  (is_command))                      \
    108     || (!(initiator) && !(is_command))) << 1)
    109 
    110 #define RFCOMM_I_CR(is_command) ((is_command) ? 0x02 : 0x00)
    111 
    112 #define RFCOMM_MAX_DLCI             61
    113 
    114 #define RFCOMM_VALID_DLCI(dlci)                             \
    115     (((dlci) == 0) || (((dlci) >= 2) && ((dlci) <= RFCOMM_MAX_DLCI)))
    116 
    117 
    118 /* Port Negotiation (PN) */
    119 #define RFCOMM_PN_DLCI_MASK         0x3F
    120 
    121 #define RFCOMM_PN_FRAM_TYPE_UIH     0x00
    122 #define RFCOMM_PN_FRAME_TYPE_MASK   0x0F
    123 
    124 #define RFCOMM_PN_CONV_LAYER_MASK   0xF0
    125 #define RFCOMM_PN_CONV_LAYER_TYPE_1 0
    126 #define RFCOMM_PN_CONV_LAYER_CBFC_I 0xF0
    127 #define RFCOMM_PN_CONV_LAYER_CBFC_R 0xE0
    128 
    129 #define RFCOMM_PN_PRIORITY_MASK     0x3F
    130 #define RFCOMM_PN_PRIORITY_0        0
    131 
    132 #define RFCOMM_PN_K_MASK            0x07
    133 
    134 #define RFCOMM_T1_DSEC              0 /* None negotiable in RFCOMM */
    135 #define RFCOMM_N2                   0 /* Number of retransmissions */
    136 #define RFCOMM_K                    0 /* Window size */
    137 #define RFCOMM_K_MAX                7 /* Max value of K for credit based flow control */
    138 
    139 #define RFCOMM_MSC_FC               0x02          /* Flow control*/
    140 #define RFCOMM_MSC_RTC              0x04          /* Ready to communicate*/
    141 #define RFCOMM_MSC_RTR              0x08          /* Ready to receive*/
    142 #define RFCOMM_MSC_IC               0x40          /* Incomming call indicator*/
    143 #define RFCOMM_MSC_DV               0x80          /* Data Valid*/
    144 
    145 #define RFCOMM_MSC_SHIFT_BREAK          4
    146 #define RFCOMM_MSC_BREAK_MASK           0xF0
    147 #define RFCOMM_MSC_BREAK_PRESENT_MASK   0x02
    148 
    149 #define RFCOMM_BAUD_RATE_2400           0x00
    150 #define RFCOMM_BAUD_RATE_4800           0x01
    151 #define RFCOMM_BAUD_RATE_7200           0x02
    152 #define RFCOMM_BAUD_RATE_9600           0x03
    153 #define RFCOMM_BAUD_RATE_19200          0x04
    154 #define RFCOMM_BAUD_RATE_38400          0x05
    155 #define RFCOMM_BAUD_RATE_57600          0x06
    156 #define RFCOMM_BAUD_RATE_115200         0x07
    157 #define RFCOMM_BAUD_RATE_230400         0x08
    158 
    159 #define RFCOMM_5_BITS                   0x00
    160 #define RFCOMM_6_BITS                   0x01
    161 #define RFCOMM_7_BITS                   0x02
    162 #define RFCOMM_8_BITS                   0x03
    163 
    164 #define RFCOMM_RPN_BITS_MASK            0x03
    165 #define RFCOMM_RPN_BITS_SHIFT           0
    166 
    167 #define RFCOMM_ONESTOPBIT               0x00
    168 #define RFCOMM_ONE5STOPBITS             0x01
    169 
    170 #define RFCOMM_RPN_STOP_BITS_MASK       0x01
    171 #define RFCOMM_RPN_STOP_BITS_SHIFT      2
    172 
    173 #define RFCOMM_PARITY_NO                0x00
    174 #define RFCOMM_PARITY_YES               0x01
    175 #define RFCOMM_RPN_PARITY_MASK          0x01
    176 #define RFCOMM_RPN_PARITY_SHIFT         3
    177 
    178 #define RFCOMM_ODD_PARITY               0x00
    179 #define RFCOMM_EVEN_PARITY              0x01
    180 #define RFCOMM_MARK_PARITY              0x02
    181 #define RFCOMM_SPACE_PARITY             0x03
    182 
    183 #define RFCOMM_RPN_PARITY_TYPE_MASK     0x03
    184 #define RFCOMM_RPN_PARITY_TYPE_SHIFT    4
    185 
    186 #define RFCOMM_FC_OFF                   0x00
    187 #define RFCOMM_FC_XONXOFF_ON_INPUT      0x01
    188 #define RFCOMM_FC_XONXOFF_ON_OUTPUT     0x02
    189 #define RFCOMM_FC_RTR_ON_INPUT          0x04
    190 #define RFCOMM_FC_RTR_ON_OUTPUT         0x08
    191 #define RFCOMM_FC_RTC_ON_INPUT          0x10
    192 #define RFCOMM_FC_RTC_ON_OUTPUT         0x20
    193 #define RFCOMM_FC_MASK                  0x3F
    194 
    195 #define RFCOMM_RPN_PM_BIT_RATE          0x0001
    196 #define RFCOMM_RPN_PM_DATA_BITS         0x0002
    197 #define RFCOMM_RPN_PM_STOP_BITS         0x0004
    198 #define RFCOMM_RPN_PM_PARITY            0x0008
    199 #define RFCOMM_RPN_PM_PARITY_TYPE       0x0010
    200 #define RFCOMM_RPN_PM_XON_CHAR          0x0020
    201 #define RFCOMM_RPN_PM_XOFF_CHAR         0x0040
    202 #define RFCOMM_RPN_PM_XONXOFF_ON_INPUT  0x0100
    203 #define RFCOMM_RPN_PM_XONXOFF_ON_OUTPUT 0x0200
    204 #define RFCOMM_RPN_PM_RTR_ON_INPUT      0x0400
    205 #define RFCOMM_RPN_PM_RTR_ON_OUTPUT     0x0800
    206 #define RFCOMM_RPN_PM_RTC_ON_INPUT      0x1000
    207 #define RFCOMM_RPN_PM_RTC_ON_OUTPUT     0x2000
    208 #define RFCOMM_RPN_PM_MASK              0x3F7F
    209 
    210 #define RFCOMM_RLS_ERROR                0x01
    211 #define RFCOMM_RLS_OVERRUN              0x02
    212 #define RFCOMM_RLS_PARITY               0x04
    213 #define RFCOMM_RLS_FRAMING              0x08
    214 
    215 /* Multiplexor channel uses DLCI 0 */
    216 #define RFCOMM_MX_DLCI                  0
    217 
    218 /*
    219 ** Define RFCOMM Multiplexer message types
    220 */
    221 #define RFCOMM_MX_PN                    0x80
    222 #define RFCOMM_MX_PN_LEN                8
    223 
    224 #define RFCOMM_MX_CLD                   0xC0
    225 #define RFCOMM_MX_CLD_LEN               0
    226 
    227 #define RFCOMM_MX_TEST                  0x20
    228 
    229 #define RFCOMM_MX_FCON                  0xA0
    230 #define RFCOMM_MX_FCON_LEN              0
    231 
    232 #define RFCOMM_MX_FCOFF                 0x60
    233 #define RFCOMM_MX_FCOFF_LEN             0
    234 
    235 #define RFCOMM_MX_MSC                   0xE0
    236 #define RFCOMM_MX_MSC_LEN_NO_BREAK      2
    237 #define RFCOMM_MX_MSC_LEN_WITH_BREAK    3
    238 
    239 #define RFCOMM_MX_NSC                   0x10
    240 #define RFCOMM_MX_NSC_LEN               1
    241 
    242 #define RFCOMM_MX_RPN                   0x90
    243 #define RFCOMM_MX_RPN_REQ_LEN           1
    244 #define RFCOMM_MX_RPN_LEN               8
    245 
    246 #define RFCOMM_MX_RLS                   0x50
    247 #define RFCOMM_MX_RLS_LEN               2
    248 #endif
    249