USB_Host_Shield_2.0
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
BTD.h
Go to the documentation of this file.
1 /* Copyright (C) 2012 Kristian Lauszus, TKJ Electronics. All rights reserved.
2 
3  This software may be distributed and modified under the terms of the GNU
4  General Public License version 2 (GPL2) as published by the Free Software
5  Foundation and appearing in the file GPL2.TXT included in the packaging of
6  this file. Please note that GPL2 Section 2[b] requires that all works based
7  on this software must also be made publicly available under the terms of
8  the GPL2 ("Copyleft").
9 
10  Contact information
11  -------------------
12 
13  Kristian Lauszus, TKJ Electronics
14  Web : http://www.tkjelectronics.com
15  e-mail : kristianl@tkjelectronics.com
16  */
17 
18 #ifndef _btd_h_
19 #define _btd_h_
20 
21 #include "Usb.h"
22 #include "confdescparser.h"
23 
24 //PID and VID of the Sony PS3 devices
25 #define PS3_VID 0x054C // Sony Corporation
26 #define PS3_PID 0x0268 // PS3 Controller DualShock 3
27 #define PS3NAVIGATION_PID 0x042F // Navigation controller
28 #define PS3MOVE_PID 0x03D5 // Motion controller
29 
30 /* Bluetooth dongle data taken from descriptors */
31 #define BULK_MAXPKTSIZE 64 // max size for ACL data
32 
33 // Used in control endpoint header for HCI Commands
34 #define bmREQ_HCI_OUT USB_SETUP_HOST_TO_DEVICE|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_DEVICE
35 // Used in control endpoint header for HID Commands
36 #define bmREQ_HID_OUT USB_SETUP_HOST_TO_DEVICE|USB_SETUP_TYPE_CLASS|USB_SETUP_RECIPIENT_INTERFACE
37 #define HID_REQUEST_SET_REPORT 0x09
38 
39 /* Bluetooth HCI states for hci_task() */
40 #define HCI_INIT_STATE 0
41 #define HCI_RESET_STATE 1
42 #define HCI_BDADDR_STATE 2
43 #define HCI_LOCAL_VERSION_STATE 3
44 #define HCI_SET_NAME_STATE 4
45 #define HCI_CHECK_WII_SERVICE 5
46 
47 #define HCI_INQUIRY_STATE 6 // These three states are only used if it should pair and connect to a Wii controller
48 #define HCI_CONNECT_WII_STATE 7
49 #define HCI_CONNECTED_WII_STATE 8
50 
51 #define HCI_SCANNING_STATE 9
52 #define HCI_CONNECT_IN_STATE 10
53 #define HCI_REMOTE_NAME_STATE 11
54 #define HCI_CONNECTED_STATE 12
55 #define HCI_DISABLE_SCAN_STATE 13
56 #define HCI_DONE_STATE 14
57 #define HCI_DISCONNECT_STATE 15
58 
59 /* HCI event flags*/
60 #define HCI_FLAG_CMD_COMPLETE 0x01
61 #define HCI_FLAG_CONN_COMPLETE 0x02
62 #define HCI_FLAG_DISCONN_COMPLETE 0x04
63 #define HCI_FLAG_REMOTE_NAME_COMPLETE 0x08
64 #define HCI_FLAG_INCOMING_REQUEST 0x10
65 #define HCI_FLAG_READ_BDADDR 0x20
66 #define HCI_FLAG_READ_VERSION 0x40
67 #define HCI_FLAG_WII_FOUND 0x80
68 #define HCI_FLAG_CONNECT_EVENT 0x100
69 
70 /*Macros for HCI event flag tests */
71 #define hci_cmd_complete (hci_event_flag & HCI_FLAG_CMD_COMPLETE)
72 #define hci_connect_complete (hci_event_flag & HCI_FLAG_CONN_COMPLETE)
73 #define hci_disconnect_complete (hci_event_flag & HCI_FLAG_DISCONN_COMPLETE)
74 #define hci_remote_name_complete (hci_event_flag & HCI_FLAG_REMOTE_NAME_COMPLETE)
75 #define hci_incoming_connect_request (hci_event_flag & HCI_FLAG_INCOMING_REQUEST)
76 #define hci_read_bdaddr_complete (hci_event_flag & HCI_FLAG_READ_BDADDR)
77 #define hci_read_version_complete (hci_event_flag & HCI_FLAG_READ_VERSION)
78 #define hci_wii_found (hci_event_flag & HCI_FLAG_WII_FOUND)
79 #define hci_connect_event (hci_event_flag & HCI_FLAG_CONNECT_EVENT)
80 
81 /* HCI Events managed */
82 #define EV_INQUIRY_COMPLETE 0x01
83 #define EV_INQUIRY_RESULT 0x02
84 #define EV_CONNECT_COMPLETE 0x03
85 #define EV_INCOMING_CONNECT 0x04
86 #define EV_DISCONNECT_COMPLETE 0x05
87 #define EV_AUTHENTICATION_COMPLETE 0x06
88 #define EV_REMOTE_NAME_COMPLETE 0x07
89 #define EV_ENCRYPTION_CHANGE 0x08
90 #define EV_CHANGE_CONNECTION_LINK 0x09
91 #define EV_ROLE_CHANGED 0x12
92 #define EV_NUM_COMPLETE_PKT 0x13
93 #define EV_PIN_CODE_REQUEST 0x16
94 #define EV_LINK_KEY_REQUEST 0x17
95 #define EV_LINK_KEY_NOTIFICATION 0x18
96 #define EV_DATA_BUFFER_OVERFLOW 0x1A
97 #define EV_MAX_SLOTS_CHANGE 0x1B
98 #define EV_READ_REMOTE_VERSION_INFORMATION_COMPLETE 0x0C
99 #define EV_QOS_SETUP_COMPLETE 0x0D
100 #define EV_COMMAND_COMPLETE 0x0E
101 #define EV_COMMAND_STATUS 0x0F
102 #define EV_LOOPBACK_COMMAND 0x19
103 #define EV_PAGE_SCAN_REP_MODE 0x20
104 
105 /* L2CAP signaling commands */
106 #define L2CAP_CMD_COMMAND_REJECT 0x01
107 #define L2CAP_CMD_CONNECTION_REQUEST 0x02
108 #define L2CAP_CMD_CONNECTION_RESPONSE 0x03
109 #define L2CAP_CMD_CONFIG_REQUEST 0x04
110 #define L2CAP_CMD_CONFIG_RESPONSE 0x05
111 #define L2CAP_CMD_DISCONNECT_REQUEST 0x06
112 #define L2CAP_CMD_DISCONNECT_RESPONSE 0x07
113 #define L2CAP_CMD_INFORMATION_REQUEST 0x0A
114 #define L2CAP_CMD_INFORMATION_RESPONSE 0x0B
115 
116 // Used For Connection Response - Remember to Include High Byte
117 #define PENDING 0x01
118 #define SUCCESSFUL 0x00
119 
120 /* Bluetooth L2CAP PSM - see http://www.bluetooth.org/Technical/AssignedNumbers/logical_link.htm */
121 #define SDP_PSM 0x01 // Service Discovery Protocol PSM Value
122 #define RFCOMM_PSM 0x03 // RFCOMM PSM Value
123 #define HID_CTRL_PSM 0x11 // HID_Control PSM Value
124 #define HID_INTR_PSM 0x13 // HID_Interrupt PSM Value
125 
126 // Used to determine if it is a Bluetooth dongle
127 #define WI_SUBCLASS_RF 0x01 // RF Controller
128 #define WI_PROTOCOL_BT 0x01 // Bluetooth Programming Interface
129 
130 #define BTD_MAX_ENDPOINTS 4
131 #define BTD_NUMSERVICES 4 // Max number of Bluetooth services
132 
133 class BluetoothService { // All services should include this class
134 public:
135  virtual void ACLData(uint8_t* ACLData); // Used to pass acldata to the services
136  virtual void Run(); // Used to run the different state machines
137  virtual void Reset(); // Used to reset the services
138  virtual void disconnect(); // Used to disconnect both the L2CAP Channel and the HCI Connection
139 };
140 
141 class BTD : public USBDeviceConfig, public UsbConfigXtracter {
142 public:
143  BTD(USB *p); // Constructor
144 
145  // USBDeviceConfig implementation
146  virtual uint8_t Init(uint8_t parent, uint8_t port, bool lowspeed);
147  virtual uint8_t Release();
148  virtual uint8_t Poll();
149  virtual uint8_t GetAddress() { return bAddress; };
150  virtual bool isReady() { return bPollEnable; };
151 
152  // UsbConfigXtracter implementation, used to extract endpoint information
153  virtual void EndpointXtract(uint8_t conf, uint8_t iface, uint8_t alt, uint8_t proto, const USB_ENDPOINT_DESCRIPTOR *ep);
154 
155  bool watingForConnection; // Use this to see if it is waiting for a incoming connection
156  void disconnect() { // Used this void to disconnect all services
157  for (uint8_t i=0; i<BTD_NUMSERVICES; i++)
158  if (btService[i])
159  btService[i]->disconnect(); // Disconnect both the L2CAP Channel and the HCI Connection
160  };
161 
162  /* Register bluetooth dongle members/services */
163  int8_t registerServiceClass(BluetoothService *pService) {
164  for (uint8_t i=0; i<BTD_NUMSERVICES; i++) {
165  if (!btService[i]) {
166  btService[i] = pService;
167  return i; // Return ID
168  }
169  }
170  return -1; // ErrorregisterServiceClass
171  };
172 
173  bool l2capConnectionClaimed; // This is used by the service to know when to store the device information
174 
175  const char* btdName; // These are set by the SPP library
176  const char* btdPin;
177 
178  uint8_t my_bdaddr[6]; // The bluetooth dongles Bluetooth address
179  uint16_t hci_handle; // HCI handle for the last connection
180  uint8_t disc_bdaddr[6]; // Last incoming devices Bluetooth address
181  uint8_t remote_name[30]; // First 30 chars of last remote name
182  uint8_t hci_version;
183 
184  bool connectToWii; // Used to only send the ACL data to the wiimote
185  bool incomingWii;
186  bool pairWithWii;
187  bool motionPlusInside; // True if it's the new Wiimote with the Motion Plus Inside
188 
189  /* HCI Commands */
190  void HCI_Command(uint8_t* data, uint16_t nbytes);
191  void hci_reset();
192  void hci_read_bdaddr();
193  void hci_read_local_version_information();
194  void hci_set_local_name(const char* name);
195  void hci_write_scan_enable();
196  void hci_remote_name();
197  void hci_accept_connection();
198  void hci_write_scan_disable();
199  void hci_disconnect(uint16_t handle);
200  void hci_pin_code_request_reply();
201  void hci_pin_code_negative_request_reply();
202  void hci_link_key_request_negative_reply();
203  void hci_authentication_request();
204  void hci_inquiry();
205  void hci_inquiry_cancel();
206  void hci_connect();
207 
208  /* L2CAP Commands */
209  void L2CAP_Command(uint16_t handle, uint8_t* data, uint8_t nbytes, uint8_t channelLow = 0x01, uint8_t channelHigh = 0x00); // Standard L2CAP header: Channel ID (0x01) for ACL-U
210  void l2cap_connection_request(uint16_t handle, uint8_t rxid, uint8_t* scid, uint16_t psm);
211  void l2cap_connection_response(uint16_t handle, uint8_t rxid, uint8_t* dcid, uint8_t* scid, uint8_t result);
212  void l2cap_config_request(uint16_t handle, uint8_t rxid, uint8_t* dcid);
213  void l2cap_config_response(uint16_t handle, uint8_t rxid, uint8_t* scid);
214  void l2cap_disconnection_request(uint16_t handle, uint8_t rxid, uint8_t* dcid, uint8_t* scid);
215  void l2cap_disconnection_response(uint16_t handle, uint8_t rxid, uint8_t* dcid, uint8_t* scid);
216  void l2cap_information_response(uint16_t handle, uint8_t rxid, uint8_t infoTypeLow, uint8_t infoTypeHigh);
217 
218 protected:
219  /* Mandatory USB members */
220  USB *pUsb;
221  uint8_t bAddress; // Device address
222  EpInfo epInfo[BTD_MAX_ENDPOINTS]; // Endpoint info structure
223 
224  uint8_t bConfNum; // Configuration number
225  uint8_t bNumEP; // Total number of endpoints in the configuration
226  uint32_t qNextPollTime; // Next poll time
227 
228  #define BTD_CONTROL_PIPE 0 // Bluetooth dongles control endpoint
229  static const uint8_t BTD_EVENT_PIPE; // HCI event endpoint index
230  static const uint8_t BTD_DATAIN_PIPE; // ACL In endpoint index
231  static const uint8_t BTD_DATAOUT_PIPE; // ACL Out endpoint index
232 
233  void PrintEndpointDescriptor(const USB_ENDPOINT_DESCRIPTOR* ep_ptr);
234 
235 private:
236  BluetoothService* btService[BTD_NUMSERVICES];
237 
238  bool bPollEnable;
239  uint8_t pollInterval;
240 
241  /* variables used by high level HCI task */
242  uint8_t hci_state; //current state of bluetooth hci connection
243  uint16_t hci_counter; // counter used for bluetooth hci reset loops
244  uint8_t hci_num_reset_loops; // this value indicate how many times it should read before trying to reset
245  uint16_t hci_event_flag; // hci flags of received bluetooth events
246  uint8_t inquiry_counter;
247 
248  uint8_t hcibuf[BULK_MAXPKTSIZE];//General purpose buffer for hci data
249  uint8_t l2capinbuf[BULK_MAXPKTSIZE];//General purpose buffer for l2cap in data
250  uint8_t l2capoutbuf[BULK_MAXPKTSIZE];//General purpose buffer for l2cap out data
251 
252  /* State machines */
253  void HCI_event_task(); // Poll the HCI event pipe
254  void HCI_task(); // HCI state machine
255  void ACL_event_task(); // ACL input pipe
256 
257  /* Used to set the Bluetooth Address internally to the PS3 Controllers */
258  void setBdaddr(uint8_t* BDADDR);
259  void setMoveBdaddr(uint8_t* BDADDR);
260 };
261 #endif
Generated on Wed Jan 30 2013 21:23:56 for USB_Host_Shield_2.0 by   doxygen 1.8.3.1