Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothACLPackets.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 #ifndef _BLUETOOTH_ACLPACKETS_
  32 #define _BLUETOOTH_ACLPACKETS_
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <string.h>
  37                 #include <stdbool.h>
  38                 #include <stdio.h>
  39
  40                 #include <LUFA/Drivers/USB/USB.h>
  41                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  42
  43                 #include "BluetoothStack.h"
  44
  45         /* Macros: */
  46                 #define BT_ACL_DEBUG(l, s, ...)           do { if (ACL_DEBUG_LEVEL >= l) printf_P(PSTR("(ACL) " s "\r\n"), ##__VA_ARGS__); } while (0)
  47                 #define ACL_DEBUG_LEVEL                   0
  48
  49                 /** Lowest possible channel number for L2CAP data channels */
  50                 #define BT_CHANNELNUMBER_BASEOFFSET       0x0040
  51
  52                 /** Bluetooth specification defined channel number for signalling commands */
  53                 #define BT_CHANNEL_SIGNALING              0x0001
  54
  55                 /** Bluetooth specification defined channel number for connectionless data */
  56                 #define BT_CHANNEL_CONNECTIONLESS         0x0002
  57
  58                 #define BT_ACL_FIRST_AUTOFLUSH            (1 << 13)
  59
  60                 #define BT_SIGNAL_COMMAND_REJECT          0x01
  61                 #define BT_SIGNAL_CONNECTION_REQUEST      0x02
  62                 #define BT_SIGNAL_CONNECTION_RESPONSE     0x03
  63                 #define BT_SIGNAL_CONFIGURATION_REQUEST   0x04
  64                 #define BT_SIGNAL_CONFIGURATION_RESPONSE  0x05
  65                 #define BT_SIGNAL_DISCONNECTION_REQUEST   0x06
  66                 #define BT_SIGNAL_DISCONNECTION_RESPONSE  0x07
  67                 #define BT_SIGNAL_ECHO_REQUEST            0x08
  68                 #define BT_SIGNAL_ECHO_RESPONSE           0x09
  69                 #define BT_SIGNAL_INFORMATION_REQUEST     0x0A
  70                 #define BT_SIGNAL_INFORMATION_RESPONSE    0x0B
  71
  72                 #define BT_INFOREQ_MTU                    0x0001
  73                 #define BT_INFOREQ_EXTENDEDFEATURES       0x0002
  74
  75                 #define BT_INFORMATION_SUCCESSFUL         0x0000
  76                 #define BT_INFORMATION_NOTSUPPORTED       0x0001
  77
  78                 #define BT_CONNECTION_SUCCESSFUL          0x0000
  79                 #define BT_CONNECTION_REFUSED_PSM         0x0002
  80                 #define BT_CONNECTION_REFUSED_RESOURCES   0x0004
  81
  82                 #define BT_CONFIGURATION_SUCCESSFUL       0x0000
  83                 #define BT_CONFIGURATION_REJECTED         0x0002
  84                 #define BT_CONFIGURATION_UNKNOWNOPTIONS   0x0003
  85
  86                 #define BT_CONFIG_OPTION_MTU              1
  87
  88         /* Type Defines: */
  89                 /** Bluetooth ACL header structure, common to all ACL data packets. */
  90                 typedef struct
  91                 {
  92                         uint16_t ConnectionHandle; /**< Unique device connection handle of the ACL packet */
  93                         uint16_t DataLength; /**< Length of the packet payload, in bytes */
  94                 } BT_ACL_Header_t;
  95
  96                 /** Bluetooth ACL data packet header structure, for ACL packets containing L2CAP data */
  97                 typedef struct
  98                 {
  99                         uint16_t PayloadLength; /**< Size of the data payload, in bytes */
 100                         uint16_t DestinationChannel; /**< Destination channel in the device the data is directed to */
 101                 } BT_DataPacket_Header_t;
 102
 103                 /** Bluetooth signalling command header structure, for all ACL packets containing a signalling command */
 104                 typedef struct
 105                 {
 106                         uint8_t  Code; /**< Signal code, a BT_SIGNAL_* mask value */
 107                         uint8_t  Identifier; /**< Unique signal command identifier to link requests and responses */
 108                         uint16_t Length; /**< Length of the signalling command data, in bytes */
 109                 } BT_Signal_Header_t;
 110
 111                 /** Connection Request signalling command structure, for channel connection requests. */
 112                 typedef struct
 113                 {
 114                         uint16_t PSM; /**< Type of data the channel will carry, a CHANNEL_PSM_* mask value */
 115                         uint16_t SourceChannel; /**< Channel source on the sending device this channel will link to */
 116                 } BT_Signal_ConnectionReq_t;
 117
 118                 /** Connection response signalling command structure, for responses to channel connection requests. */
 119                 typedef struct
 120                 {
 121                         uint16_t DestinationChannel; /**< Destination device channel that the connection request was processed on */
 122                         uint16_t SourceChannel; /**< Source device channel address that the connection request came from */
 123                         uint16_t Result; /**< Connection result, a BT_CONNECTION_* mask value */
 124                         uint16_t Status; /**< Status of the request if the result was set to the Pending value */
 125                 } BT_Signal_ConnectionResp_t;
 126
 127                 /** Disconnection request signalling command structure, for channel disconnection requests. */
 128                 typedef struct
 129                 {
 130                         uint16_t DestinationChannel; /**< Destination channel address which is to be disconnected */
 131                         uint16_t SourceChannel; /**< Source channel address which is to be disconnected */
 132                 } BT_Signal_DisconnectionReq_t;
 133
 134                 /** Disconnection response signalling command structure, for responses to channel disconnection requests. */
 135                 typedef struct
 136                 {
 137                         uint16_t DestinationChannel; /**< Destination channel address which was disconnected */
 138                         uint16_t SourceChannel; /**< Source channel address which was disconnected */
 139                 } BT_Signal_DisconnectionResp_t;
 140
 141                 /** Configuration Request signalling command structure, for channel configuration requests. */
 142                 typedef struct
 143                 {
 144                         uint16_t DestinationChannel; /**< Destination channel address which is to be disconnected */
 145                         uint16_t Flags; /**< Configuration flags for the request, including command continuation */
 146                 } BT_Signal_ConfigurationReq_t;
 147
 148                 /** Configuration Response signalling command structure, for responses to channel configuration requests. */
 149                 typedef struct
 150                 {
 151                         uint16_t SourceChannel; /**< Source channel that the configuration request was directed at */
 152                         uint16_t Flags; /**< Configuration flags for the response, including response continuation */
 153                         uint16_t Result; /**< Configuration result, a BT_CONFIGURATION_* mask value */
 154                 } BT_Signal_ConfigurationResp_t;
 155
 156                 /** Information Request signalling command structure, for device information requests. */
 157                 typedef struct
 158                 {
 159                         uint16_t InfoType; /**< Data type that is being requested, a BT_INFOREQ_* mask value */
 160                 } BT_Signal_InformationReq_t;
 161
 162                 /** Information Response signalling command structure, for responses to information requests. */
 163                 typedef struct
 164                 {
 165                         uint16_t InfoType; /**< Data type that was requested, a BT_INFOREQ_* mask value */
 166                         uint16_t Result; /**< Result of the request, a BT_INFORMATION_* mask value */
 167                 } BT_Signal_InformationResp_t;
 168
 169                 /** Configuration Option header structure, placed at the start of each option in a Channel Configuration
 170                  *  request's options list.
 171                  */
 172                 typedef struct
 173                 {
 174                         uint8_t Type; /**< Option type, a BT_CONFIG_OPTION_* mask value */
 175                         uint8_t Length; /**< Length of the option's value, in bytes */
 176                 } BT_Config_Option_Header_t;
 177
 178         /* Function Prototypes: */
 179                 void Bluetooth_ACLTask(void);
 180
 181                 #if defined(INCLUDE_FROM_BLUETOOTH_ACLPACKETS_C)
 182                         static void Bluetooth_ProcessIncommingACLPackets(void);
 183
 184                         static inline void Bluetooth_Signal_ConnectionReq(const BT_Signal_Header_t* const SignalCommandHeader);
 185                         static inline void Bluetooth_Signal_ConnectionResp(const BT_Signal_Header_t* const SignalCommandHeader);
 186                         static inline void Bluetooth_Signal_ConfigurationReq(const BT_Signal_Header_t* const SignalCommandHeader);
 187                         static inline void Bluetooth_Signal_ConfigurationResp(const BT_Signal_Header_t* const SignalCommandHeader);
 188                         static inline void Bluetooth_Signal_DisconnectionReq(const BT_Signal_Header_t* const SignalCommandHeader);
 189                         static inline void Bluetooth_Signal_DisconnectionResp(const BT_Signal_Header_t* const SignalCommandHeader);
 190                         static inline void Bluetooth_Signal_EchoReq(const BT_Signal_Header_t* const SignalCommandHeader);
 191                         static inline void Bluetooth_Signal_InformationReq(const BT_Signal_Header_t* const SignalCommandHeader);
 192                 #endif
 193
 194 #endif