1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 // ***************************************************************************** 39 /* EXAMPLE_START(spp_counter): SPP Server - Heartbeat Counter over RFCOMM 40 * 41 * @text The Serial port profile (SPP) is widely used as it provides a serial 42 * port over Bluetooth. The SPP counter example demonstrates how to setup an SPP 43 * service, and provide a periodic timer over RFCOMM. 44 */ 45 // ***************************************************************************** 46 47 #include <inttypes.h> 48 #include <stdint.h> 49 #include <stdio.h> 50 #include <stdlib.h> 51 #include <string.h> 52 53 #include "btstack_config.h" 54 55 #include "btstack_run_loop.h" 56 #include "classic/sdp_util.h" 57 58 #include "btstack_debug.h" 59 #include "btstack_memory.h" 60 #include "hci.h" 61 #include "hci_dump.h" 62 63 #include "l2cap.h" 64 65 #include "classic/rfcomm.h" 66 67 #include "classic/sdp_server.h" 68 69 #define RFCOMM_SERVER_CHANNEL 1 70 #define HEARTBEAT_PERIOD_MS 1000 71 72 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 73 74 static uint16_t rfcomm_channel_id; 75 static uint8_t spp_service_buffer[150]; 76 static btstack_packet_callback_registration_t hci_event_callback_registration; 77 78 79 /* @section SPP Service Setup 80 *s 81 * @text To provide an SPP service, the L2CAP, RFCOMM, and SDP protocol layers 82 * are required. After setting up an RFCOMM service with channel nubmer 83 * RFCOMM_SERVER_CHANNEL, an SDP record is created and registered with the SDP server. 84 * Example code for SPP service setup is 85 * provided in Listing SPPSetup. The SDP record created by function 86 * sdp_create_spp_service consists of a basic SPP definition that uses the provided 87 * RFCOMM channel ID and service name. For more details, please have a look at it 88 * in \path{src/sdp_util.c}. 89 * The SDP record is created on the fly in RAM and is deterministic. 90 * To preserve valuable RAM, the result could be stored as constant data inside the ROM. 91 */ 92 93 /* LISTING_START(SPPSetup): SPP service setup */ 94 static void spp_service_setup(void){ 95 96 // register for HCI events 97 hci_event_callback_registration.callback = &packet_handler; 98 hci_add_event_handler(&hci_event_callback_registration); 99 100 l2cap_init(); 101 102 rfcomm_init(); 103 rfcomm_register_service(packet_handler, RFCOMM_SERVER_CHANNEL, 0xffff); // reserved channel, mtu limited by l2cap 104 105 // init SDP, create record for SPP and register with SDP 106 sdp_init(); 107 memset(spp_service_buffer, 0, sizeof(spp_service_buffer)); 108 sdp_create_spp_service(spp_service_buffer, 0x10001, RFCOMM_SERVER_CHANNEL, "SPP Counter"); 109 sdp_register_service(spp_service_buffer); 110 printf("SDP service record size: %u\n", de_get_len(spp_service_buffer)); 111 } 112 /* LISTING_END */ 113 114 /* @section Periodic Timer Setup 115 * 116 * @text The heartbeat handler increases the real counter every second, 117 * and sends a text string with the counter value, as shown in Listing PeriodicCounter. 118 */ 119 120 /* LISTING_START(PeriodicCounter): Periodic Counter */ 121 static btstack_timer_source_t heartbeat; 122 123 static void heartbeat_handler(struct btstack_timer_source *ts){ 124 static int counter = 0; 125 126 if (rfcomm_channel_id){ 127 char lineBuffer[30]; 128 sprintf(lineBuffer, "BTstack counter %04u\n", ++counter); 129 printf("%s", lineBuffer); 130 if (rfcomm_can_send_packet_now(rfcomm_channel_id)) { 131 int err = rfcomm_send(rfcomm_channel_id, (uint8_t*) lineBuffer, strlen(lineBuffer)); 132 if (err) { 133 log_error("rfcomm_send -> error 0X%02x", err); 134 } 135 } 136 } 137 btstack_run_loop_set_timer(ts, HEARTBEAT_PERIOD_MS); 138 btstack_run_loop_add_timer(ts); 139 } 140 141 static void one_shot_timer_setup(void){ 142 // set one-shot timer 143 heartbeat.process = &heartbeat_handler; 144 btstack_run_loop_set_timer(&heartbeat, HEARTBEAT_PERIOD_MS); 145 btstack_run_loop_add_timer(&heartbeat); 146 } 147 /* LISTING_END */ 148 149 150 /* @section Bluetooth Logic 151 * @text The Bluetooth logic is implemented within the 152 * packet handler, see Listing SppServerPacketHandler. In this example, 153 * the following events are passed sequentially: 154 * - BTSTACK_EVENT_STATE, 155 * - HCI_EVENT_PIN_CODE_REQUEST (Standard pairing) or 156 * - HCI_EVENT_USER_CONFIRMATION_REQUEST (Secure Simple Pairing), 157 * - RFCOMM_EVENT_INCOMING_CONNECTION, 158 * - RFCOMM_EVENT_OPEN_CHANNEL_COMPLETE, and 159 * - RFCOMM_EVENT_CHANNEL_CLOSED 160 */ 161 162 /* @text Upon receiving HCI_EVENT_PIN_CODE_REQUEST event, we need to handle 163 * authentication. Here, we use a fixed PIN code "0000". 164 * 165 * When HCI_EVENT_USER_CONFIRMATION_REQUEST is received, the user will be 166 * asked to accept the pairing request. If the IO capability is set to 167 * SSP_IO_CAPABILITY_DISPLAY_YES_NO, the request will be automatically accepted. 168 * 169 * The RFCOMM_EVENT_INCOMING_CONNECTION event indicates an incoming connection. 170 * Here, the connection is accepted. More logic is need, if you want to handle connections 171 * from multiple clients. The incoming RFCOMM connection event contains the RFCOMM 172 * channel number used during the SPP setup phase and the newly assigned RFCOMM 173 * channel ID that is used by all BTstack commands and events. 174 * 175 * If RFCOMM_EVENT_OPEN_CHANNEL_COMPLETE event returns status greater then 0, 176 * then the channel establishment has failed (rare case, e.g., client crashes). 177 * On successful connection, the RFCOMM channel ID and MTU for this 178 * channel are made available to the heartbeat counter. After opening the RFCOMM channel, 179 * the communication between client and the application 180 * takes place. In this example, the timer handler increases the real counter every 181 * second. 182 */ 183 184 /* LISTING_START(SppServerPacketHandler): SPP Server - Heartbeat Counter over RFCOMM */ 185 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 186 /* LISTING_PAUSE */ 187 bd_addr_t event_addr; 188 uint8_t rfcomm_channel_nr; 189 uint16_t mtu; 190 int i; 191 192 switch (packet_type) { 193 case HCI_EVENT_PACKET: 194 switch (packet[0]) { 195 196 case BTSTACK_EVENT_STATE: 197 // BTstack activated, get started 198 if (packet[2] == HCI_STATE_WORKING) { 199 printf("BTstack is up and running\n"); 200 } 201 break; 202 /* LISTING_RESUME */ 203 case HCI_EVENT_PIN_CODE_REQUEST: 204 // pre-ssp: inform about pin code request 205 printf("Pin code request - using '0000'\n"); 206 reverse_bd_addr(&packet[2], event_addr); 207 hci_send_cmd(&hci_pin_code_request_reply, &event_addr, 4, "0000"); 208 break; 209 210 case HCI_EVENT_USER_CONFIRMATION_REQUEST: 211 // ssp: inform about user confirmation request 212 printf("SSP User Confirmation Request with numeric value '%06"PRIu32"'\n", little_endian_read_32(packet, 8)); 213 printf("SSP User Confirmation Auto accept\n"); 214 break; 215 216 case RFCOMM_EVENT_INCOMING_CONNECTION: 217 // data: event (8), len(8), address(48), channel (8), rfcomm_cid (16) 218 reverse_bd_addr(&packet[2], event_addr); 219 rfcomm_channel_nr = packet[8]; 220 rfcomm_channel_id = little_endian_read_16(packet, 9); 221 printf("RFCOMM channel %u requested for %s\n", rfcomm_channel_nr, bd_addr_to_str(event_addr)); 222 rfcomm_accept_connection(rfcomm_channel_id); 223 break; 224 225 case RFCOMM_EVENT_OPEN_CHANNEL_COMPLETE: 226 // data: event(8), len(8), status (8), address (48), server channel(8), rfcomm_cid(16), max frame size(16) 227 if (packet[2]) { 228 printf("RFCOMM channel open failed, status %u\n", packet[2]); 229 } else { 230 rfcomm_channel_id = little_endian_read_16(packet, 12); 231 mtu = little_endian_read_16(packet, 14); 232 printf("RFCOMM channel open succeeded. New RFCOMM Channel ID %u, max frame size %u\n", rfcomm_channel_id, mtu); 233 } 234 break; 235 /* LISTING_PAUSE */ 236 case RFCOMM_EVENT_CHANNEL_CLOSED: 237 printf("RFCOMM channel closed\n"); 238 rfcomm_channel_id = 0; 239 break; 240 241 default: 242 break; 243 } 244 break; 245 246 case RFCOMM_DATA_PACKET: 247 printf("RCV: '"); 248 for (i=0;i<size;i++){ 249 putchar(packet[i]); 250 } 251 printf("'\n"); 252 break; 253 254 default: 255 break; 256 } 257 /* LISTING_RESUME */ 258 } 259 /* LISTING_END */ 260 261 int btstack_main(int argc, const char * argv[]); 262 int btstack_main(int argc, const char * argv[]){ 263 one_shot_timer_setup(); 264 spp_service_setup(); 265 266 gap_discoverable_control(1); 267 gap_ssp_set_io_capability(SSP_IO_CAPABILITY_DISPLAY_YES_NO); 268 gap_set_local_name("BTstack SPP Counter"); 269 270 // turn on! 271 hci_power_control(HCI_POWER_ON); 272 273 return 0; 274 } 275 /* EXAMPLE_END */ 276 277