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 /** \file
  32  *
  33  *  Header file for BluetoothACLPackets.c.
  34  */
  35
  36 #ifndef _BLUETOOTH_ACLPACKETS_
  37 #define _BLUETOOTH_ACLPACKETS_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <string.h>
  42                 #include <stdbool.h>
  43                 #include <stdio.h>
  44
  45                 #include <LUFA/Drivers/USB/USB.h>
  46                 #include <LUFA/Drivers/Peripheral/SerialStream.h>
  47
  48                 #include "BluetoothStack.h"
  49
  50         /* Macros: */
  51                 #define BT_ACL_DEBUG(l, s, ...)           do { if (ACL_DEBUG_LEVEL >= l) printf_P(PSTR("(ACL) " s "\r\n"), ##__VA_ARGS__); } while (0)
  52                 #define ACL_DEBUG_LEVEL                   0
  53
  54                 /** Lowest possible channel number for L2CAP data channels. */
  55                 #define BT_CHANNELNUMBER_BASEOFFSET       0x0040
  56
  57                 /** Bluetooth specification defined channel number for signalling commands. */
  58                 #define BT_CHANNEL_SIGNALING              0x0001
  59
  60                 /** Bluetooth specification defined channel number for connectionless data. */
  61                 #define BT_CHANNEL_CONNECTIONLESS         0x0002
  62
  63                 #define BT_ACL_FIRST_AUTOFLUSH            (1 << 13)
  64
  65                 #define BT_SIGNAL_COMMAND_REJECT          0x01
  66                 #define BT_SIGNAL_CONNECTION_REQUEST      0x02
  67                 #define BT_SIGNAL_CONNECTION_RESPONSE     0x03
  68                 #define BT_SIGNAL_CONFIGURATION_REQUEST   0x04
  69                 #define BT_SIGNAL_CONFIGURATION_RESPONSE  0x05
  70                 #define BT_SIGNAL_DISCONNECTION_REQUEST   0x06
  71                 #define BT_SIGNAL_DISCONNECTION_RESPONSE  0x07
  72                 #define BT_SIGNAL_ECHO_REQUEST            0x08
  73                 #define BT_SIGNAL_ECHO_RESPONSE           0x09
  74                 #define BT_SIGNAL_INFORMATION_REQUEST     0x0A
  75                 #define BT_SIGNAL_INFORMATION_RESPONSE    0x0B
  76
  77                 #define BT_INFOREQ_MTU                    0x0001
  78                 #define BT_INFOREQ_EXTENDEDFEATURES       0x0002
  79
  80                 #define BT_INFORMATION_SUCCESSFUL         0x0000
  81                 #define BT_INFORMATION_NOTSUPPORTED       0x0001
  82
  83                 #define BT_CONNECTION_SUCCESSFUL          0x0000
  84                 #define BT_CONNECTION_REFUSED_PSM         0x0002
  85                 #define BT_CONNECTION_REFUSED_RESOURCES   0x0004
  86
  87                 #define BT_CONFIGURATION_SUCCESSFUL       0x0000
  88                 #define BT_CONFIGURATION_REJECTED         0x0002
  89                 #define BT_CONFIGURATION_UNKNOWNOPTIONS   0x0003
  90
  91                 #define BT_CONFIG_OPTION_MTU              1
  92
  93         /* Type Defines: */
  94                 /** Bluetooth ACL header structure, common to all ACL data packets. */
  95                 typedef struct
  96                 {
  97                         uint16_t ConnectionHandle; /**< Unique device connection handle of the ACL packet */
  98                         uint16_t DataLength; /**< Length of the packet payload, in bytes */
  99                 } BT_ACL_Header_t;
 100
 101                 /** Bluetooth ACL data packet header structure, for ACL packets containing L2CAP data. */
 102                 typedef struct
 103                 {
 104                         uint16_t PayloadLength; /**< Size of the data payload, in bytes */
 105                         uint16_t DestinationChannel; /**< Destination channel in the device the data is directed to */
 106                 } BT_DataPacket_Header_t;
 107
 108                 /** Bluetooth signalling command header structure, for all ACL packets containing a signalling command. */
 109                 typedef struct
 110                 {
 111                         uint8_t  Code; /**< Signal code, a BT_SIGNAL_* mask value */
 112                         uint8_t  Identifier; /**< Unique signal command identifier to link requests and responses */
 113                         uint16_t Length; /**< Length of the signalling command data, in bytes */
 114                 } BT_Signal_Header_t;
 115
 116                 /** Connection Request signalling command structure, for channel connection requests. */
 117                 typedef struct
 118                 {
 119                         uint16_t PSM; /**< Type of data the channel will carry, a CHANNEL_PSM_* mask value */
 120                         uint16_t SourceChannel; /**< Channel source on the sending device this channel will link to */
 121                 } BT_Signal_ConnectionReq_t;
 122
 123                 /** Connection response signalling command structure, for responses to channel connection requests. */
 124                 typedef struct
 125                 {
 126                         uint16_t DestinationChannel; /**< Destination device channel that the connection request was processed on */
 127                         uint16_t SourceChannel; /**< Source device channel address that the connection request came from */
 128                         uint16_t Result; /**< Connection result, a BT_CONNECTION_* mask value */
 129                         uint16_t Status; /**< Status of the request if the result was set to the Pending value */
 130                 } BT_Signal_ConnectionResp_t;
 131
 132                 /** Disconnection request signalling command structure, for channel disconnection requests. */
 133                 typedef struct
 134                 {
 135                         uint16_t DestinationChannel; /**< Destination channel address which is to be disconnected */
 136                         uint16_t SourceChannel; /**< Source channel address which is to be disconnected */
 137                 } BT_Signal_DisconnectionReq_t;
 138
 139                 /** Disconnection response signalling command structure, for responses to channel disconnection requests. */
 140                 typedef struct
 141                 {
 142                         uint16_t DestinationChannel; /**< Destination channel address which was disconnected */
 143                         uint16_t SourceChannel; /**< Source channel address which was disconnected */
 144                 } BT_Signal_DisconnectionResp_t;
 145
 146                 /** Configuration Request signalling command structure, for channel configuration requests. */
 147                 typedef struct
 148                 {
 149                         uint16_t DestinationChannel; /**< Destination channel address which is to be disconnected */
 150                         uint16_t Flags; /**< Configuration flags for the request, including command continuation */
 151                 } BT_Signal_ConfigurationReq_t;
 152
 153                 /** Configuration Response signalling command structure, for responses to channel configuration requests. */
 154                 typedef struct
 155                 {
 156                         uint16_t SourceChannel; /**< Source channel that the configuration request was directed at */
 157                         uint16_t Flags; /**< Configuration flags for the response, including response continuation */
 158                         uint16_t Result; /**< Configuration result, a BT_CONFIGURATION_* mask value */
 159                 } BT_Signal_ConfigurationResp_t;
 160
 161                 /** Information Request signalling command structure, for device information requests. */
 162                 typedef struct
 163                 {
 164                         uint16_t InfoType; /**< Data type that is being requested, a BT_INFOREQ_* mask value */
 165                 } BT_Signal_InformationReq_t;
 166
 167                 /** Information Response signalling command structure, for responses to information requests. */
 168                 typedef struct
 169                 {
 170                         uint16_t InfoType; /**< Data type that was requested, a BT_INFOREQ_* mask value */
 171                         uint16_t Result; /**< Result of the request, a BT_INFORMATION_* mask value */
 172                 } BT_Signal_InformationResp_t;
 173
 174                 /** Configuration Option header structure, placed at the start of each option in a Channel Configuration
 175                  *  request's options list.
 176                  */
 177                 typedef struct
 178                 {
 179                         uint8_t Type; /**< Option type, a BT_CONFIG_OPTION_* mask value */
 180                         uint8_t Length; /**< Length of the option's value, in bytes */
 181                 } BT_Config_Option_Header_t;
 182
 183         /* Function Prototypes: */
 184                 void Bluetooth_ACLTask(void);
 185
 186                 #if defined(INCLUDE_FROM_BLUETOOTH_ACLPACKETS_C)
 187                         static void Bluetooth_ProcessIncommingACLPackets(void);
 188
 189                         static inline void Bluetooth_Signal_ConnectionReq(const BT_Signal_Header_t* const SignalCommandHeader);
 190                         static inline void Bluetooth_Signal_ConnectionResp(const BT_Signal_Header_t* const SignalCommandHeader);
 191                         static inline void Bluetooth_Signal_ConfigurationReq(const BT_Signal_Header_t* const SignalCommandHeader);
 192                         static inline void Bluetooth_Signal_ConfigurationResp(const BT_Signal_Header_t* const SignalCommandHeader);
 193                         static inline void Bluetooth_Signal_DisconnectionReq(const BT_Signal_Header_t* const SignalCommandHeader);
 194                         static inline void Bluetooth_Signal_DisconnectionResp(const BT_Signal_Header_t* const SignalCommandHeader);
 195                         static inline void Bluetooth_Signal_EchoReq(const BT_Signal_Header_t* const SignalCommandHeader);
 196                         static inline void Bluetooth_Signal_InformationReq(const BT_Signal_Header_t* const SignalCommandHeader);
 197                 #endif
 198
 199 #endif