Demos/Host/Incomplete/BluetoothHost/Lib/BluetoothHCICommands.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_HCICOMMANDS_H_
  32 #define _BLUETOOTH_HCICOMMANDS_H_
  33
  34         /* Includes: */
  35                 #include <avr/io.h>
  36                 #include <string.h>
  37                 #include <stdbool.h>
  38
  39                 #include <LUFA/Drivers/USB/USB.h>
  40
  41                 #include "BluetoothStack.h"
  42                 #include "BluetoothClassCodes.h"
  43
  44         /* Macros: */
  45                 #define BT_HCI_DEBUG(s, ...)                           printf_P(PSTR("(HCI) " s "\r\n"), __VA_ARGS__)
  46
  47                 #define OGF_LINK_CONTROL                               0x01
  48                 #define OGF_CTRLR_BASEBAND                             0x03
  49                 #define OGF_CTRLR_INFORMATIONAL                        0x04
  50
  51                 #define OCF_LINK_CONTROL_INQUIRY                       0x0001
  52                 #define OCF_LINK_CONTROL_INQUIRY_CANCEL                0x0002
  53                 #define OCF_LINK_CONTROL_PERIODIC_INQUIRY              0x0003
  54                 #define OCF_LINK_CONTROL_EXIT_PERIODIC_INQUIRY         0x0004
  55                 #define OCF_LINK_CONTROL_CREATE_CONNECTION             0x0005
  56                 #define OCF_LINK_CONTROL_DISCONNECT                    0x0006
  57                 #define OCF_LINK_CONTROL_CREATE_CONNECTION_CANCEL      0x0008
  58                 #define OCF_LINK_CONTROL_ACCEPT_CONNECTION_REQUEST     0x0009
  59                 #define OCF_LINK_CONTROL_REJECT_CONNECTION_REQUEST     0x000A
  60                 #define OCF_LINK_CONTROL_LINK_KEY_REQUEST_REPLY        0x000B
  61                 #define OCF_LINK_CONTROL_LINK_KEY_REQUEST_NEG_REPLY    0x000C
  62                 #define OCF_LINK_CONTROL_PIN_CODE_REQUEST_REPLY        0x000D
  63                 #define OCF_LINK_CONTROL_PIN_CODE_REQUEST_NEG_REPLY    0x000E
  64                 #define OCF_LINK_CONTROL_CHANGE_CONNECTION_PACKET_TYPE 0x000F
  65                 #define OCF_LINK_CONTROL_REMOTE_NAME_REQUEST           0x0019
  66                 #define OCF_CTRLR_BASEBAND_SET_EVENT_MASK              0x0001
  67                 #define OCF_CTRLR_BASEBAND_RESET                       0x0003
  68                 #define OCF_CTRLR_BASEBAND_WRITE_PIN_TYPE              0x000A
  69                 #define OCF_CTRLR_BASEBAND_WRITE_LOCAL_NAME            0x0013
  70                 #define OCF_CTRLR_BASEBAND_READ_LOCAL_NAME             0x0014
  71                 #define OCF_CTRLR_BASEBAND_WRITE_SCAN_ENABLE           0x001A
  72                 #define OCF_CTRLR_BASEBAND_WRITE_CLASS_OF_DEVICE       0x0024
  73                 #define OCF_CTRLR_BASEBAND_WRITE_SIMPLE_PAIRING_MODE   0x0056
  74                 #define OCF_CTRLR_BASEBAND_WRITE_AUTHENTICATION_ENABLE 0x0020
  75                 #define OGF_CTRLR_INFORMATIONAL_READBUFFERSIZE         0x0005
  76
  77                 #define EVENT_COMMAND_STATUS                           0x0F
  78                 #define EVENT_COMMAND_COMPLETE                         0x0E
  79                 #define EVENT_CONNECTION_COMPLETE                      0x03
  80                 #define EVENT_CONNECTION_REQUEST                       0x04
  81                 #define EVENT_DISCONNECTION_COMPLETE                   0x05
  82                 #define EVENT_REMOTE_NAME_REQUEST_COMPLETE             0x07
  83                 #define EVENT_PIN_CODE_REQUEST                         0x16
  84
  85                 #define ERROR_LIMITED_RESOURCES                        0x0D
  86
  87         /* Type Defines: */
  88                 typedef struct
  89                 {
  90                         struct
  91                         {
  92                                 int OCF : 10;
  93                                 int OGF : 6;
  94                         } OpCode;
  95
  96                         uint8_t  ParameterLength;
  97                         uint8_t  Parameters[];
  98                 } Bluetooth_HCICommand_Header_t;
  99
 100                 typedef struct
 101                 {
 102                         uint8_t  EventCode;
 103                         uint8_t  ParameterLength;
 104                 } Bluetooth_HCIEvent_Header_t;
 105
 106                 typedef struct
 107                 {
 108                         uint8_t Status;
 109                         uint8_t Packets;
 110
 111                         struct
 112                         {
 113                                 int OCF : 10;
 114                                 int OGF : 6;
 115                         } OpCode;
 116                 } Bluetooth_HCIEvent_CommandStatus_t;
 117
 118                 typedef struct
 119                 {
 120                         uint8_t  HCLPacketsAllowable;
 121                         uint16_t Opcode;
 122                         uint8_t  ReturnParams[];
 123                 } Bluetooth_HCIEvent_CommandComplete_t;
 124
 125                 typedef struct
 126                 {
 127                         uint8_t  RemoteAddress[6];
 128                         uint8_t  ClassOfDevice_Service;
 129                         uint16_t ClassOfDevice_MajorMinor;
 130                         uint8_t  LinkType;
 131                 } Bluetooth_HCIEvent_ConnectionRequest_t;
 132
 133                 typedef struct
 134                 {
 135                         uint8_t  Status;
 136                         uint16_t ConnectionHandle;
 137                         uint8_t  RemoteAddress[6];
 138                         uint8_t  LinkType;
 139                         uint8_t  EncryptionEnabled;
 140                 } Bluetooth_HCIEvent_ConnectionComplete_t;
 141
 142                 typedef struct
 143                 {
 144                         uint8_t  RemoteAddress[6];
 145                 } Bluetooth_HCIEvent_PinCodeRequest_t;
 146
 147                 typedef struct
 148                 {
 149                         uint8_t  RemoteAddress[6];
 150                         uint8_t  SlaveRole;
 151                 } Bluetooth_HCICommand_AcceptConnectionRequest_t;
 152
 153                 typedef struct
 154                 {
 155                         uint8_t  RemoteAddress[6];
 156                         uint8_t  Reason;
 157                 } Bluetooth_HCICommand_RejectConnectionRequest_t;
 158
 159                 typedef struct
 160                 {
 161                         uint8_t  RemoteAddress[6];
 162                         uint8_t  PINCodeLength;
 163                         char     PINCode[16];
 164                 } Bluetooth_HCICommand_PinCodeResponse_t;
 165
 166         /* Enums: */
 167                 enum Bluetooth_ScanEnable_Modes_t
 168                 {
 169                         BT_SCANMODE_NoScansEnabled       = 0,
 170                         BT_SCANMODE_InquiryScanOnly      = 1,
 171                         BT_SCANMODE_PageScanOnly         = 2,
 172                         BT_SCANMODE_InquiryAndPageScans  = 3,
 173                 };
 174
 175                 enum BluetoothStack_States_t
 176                 {
 177                         Bluetooth_ProcessEvents          = 0,
 178                         Bluetooth_Init                   = 1,
 179                         Bluetooth_Init_Reset             = 2,
 180                         Bluetooth_Init_SetLocalName      = 3,
 181                         Bluetooth_Init_SetDeviceClass    = 4,
 182                         Bluetooth_Init_WriteScanEnable   = 5,
 183                         Bluetooth_Conn_AcceptConnection  = 6,
 184                         Bluetooth_Conn_RejectConnection  = 7,
 185                         Bluetooth_Conn_SendPINCode       = 8,
 186                 };
 187
 188         /* External Variables: */
 189                 extern uint8_t Bluetooth_HCIProcessingState;
 190
 191         /* Function Prototypes: */
 192                 void Bluetooth_ProcessHCICommands(void);
 193                 void Bluetooth_ProcessHCIEvents(void);
 194
 195                 #if defined(INCLUDE_FROM_BLUETOOTHHCICOMMANDS_C)
 196                         static uint8_t Bluetooth_SendHCICommand(void* Parameters, uint16_t ParameterLength);
 197                 #endif
 198
 199 #endif