stack/include/rfcdefs.h

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