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 #define BTSTACK_FILE__ "spp_counter.c" 39 40 // ***************************************************************************** 41 /* EXAMPLE_START(spp_counter): SPP Server - Heartbeat Counter over RFCOMM 42 * 43 * @text The Serial port profile (SPP) is widely used as it provides a serial 44 * port over Bluetooth. The SPP counter example demonstrates how to setup an SPP 45 * service, and provide a periodic timer over RFCOMM. 46 * 47 * @text Note: To test, please run the spp_counter example, and then pair from 48 * a remote device, and open the Virtual Serial Port. 49 */ 50 // ***************************************************************************** 51 52 #include <inttypes.h> 53 #include <stdint.h> 54 #include <stdio.h> 55 #include <stdlib.h> 56 #include <string.h> 57 58 #include "btstack.h" 59 60 #define RFCOMM_SERVER_CHANNEL 1 61 #define HEARTBEAT_PERIOD_MS 1000 62 63 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 64 65 static uint16_t rfcomm_channel_id; 66 static uint8_t spp_service_buffer[150]; 67 static btstack_packet_callback_registration_t hci_event_callback_registration; 68 69 70 /* @section SPP Service Setup 71 *s 72 * @text To provide an SPP service, the L2CAP, RFCOMM, and SDP protocol layers 73 * are required. After setting up an RFCOMM service with channel nubmer 74 * RFCOMM_SERVER_CHANNEL, an SDP record is created and registered with the SDP server. 75 * Example code for SPP service setup is 76 * provided in Listing SPPSetup. The SDP record created by function 77 * spp_create_sdp_record consists of a basic SPP definition that uses the provided 78 * RFCOMM channel ID and service name. For more details, please have a look at it 79 * in \path{src/sdp_util.c}. 80 * The SDP record is created on the fly in RAM and is deterministic. 81 * To preserve valuable RAM, the result could be stored as constant data inside the ROM. 82 */ 83 84 /* LISTING_START(SPPSetup): SPP service setup */ 85 static void spp_service_setup(void){ 86 87 // register for HCI events 88 hci_event_callback_registration.callback = &packet_handler; 89 hci_add_event_handler(&hci_event_callback_registration); 90 91 l2cap_init(); 92 93 rfcomm_init(); 94 rfcomm_register_service(packet_handler, RFCOMM_SERVER_CHANNEL, 0xffff); // reserved channel, mtu limited by l2cap 95 96 // init SDP, create record for SPP and register with SDP 97 sdp_init(); 98 memset(spp_service_buffer, 0, sizeof(spp_service_buffer)); 99 spp_create_sdp_record(spp_service_buffer, 0x10001, RFCOMM_SERVER_CHANNEL, "SPP Counter"); 100 sdp_register_service(spp_service_buffer); 101 } 102 /* LISTING_END */ 103 104 /* @section Periodic Timer Setup 105 * 106 * @text The heartbeat handler increases the real counter every second, 107 * and sends a text string with the counter value, as shown in Listing PeriodicCounter. 108 */ 109 110 /* LISTING_START(PeriodicCounter): Periodic Counter */ 111 static btstack_timer_source_t heartbeat; 112 static char lineBuffer[30]; 113 static void heartbeat_handler(struct btstack_timer_source *ts){ 114 static int counter = 0; 115 116 if (rfcomm_channel_id){ 117 sprintf(lineBuffer, "BTstack counter %04u\n", ++counter); 118 119 rfcomm_request_can_send_now_event(rfcomm_channel_id); 120 } 121 122 btstack_run_loop_set_timer(ts, HEARTBEAT_PERIOD_MS); 123 btstack_run_loop_add_timer(ts); 124 } 125 126 static void one_shot_timer_setup(void){ 127 // set one-shot timer 128 heartbeat.process = &heartbeat_handler; 129 btstack_run_loop_set_timer(&heartbeat, HEARTBEAT_PERIOD_MS); 130 btstack_run_loop_add_timer(&heartbeat); 131 } 132 /* LISTING_END */ 133 134 135 /* @section Bluetooth Logic 136 * @text The Bluetooth logic is implemented within the 137 * packet handler, see Listing SppServerPacketHandler. In this example, 138 * the following events are passed sequentially: 139 * - BTSTACK_EVENT_STATE, 140 * - HCI_EVENT_PIN_CODE_REQUEST (Standard pairing) or 141 * - HCI_EVENT_USER_CONFIRMATION_REQUEST (Secure Simple Pairing), 142 * - RFCOMM_EVENT_INCOMING_CONNECTION, 143 * - RFCOMM_EVENT_CHANNEL_OPENED, 144 * - RFCOMM_EVETN_CAN_SEND_NOW, and 145 * - RFCOMM_EVENT_CHANNEL_CLOSED 146 */ 147 148 /* @text Upon receiving HCI_EVENT_PIN_CODE_REQUEST event, we need to handle 149 * authentication. Here, we use a fixed PIN code "0000". 150 * 151 * When HCI_EVENT_USER_CONFIRMATION_REQUEST is received, the user will be 152 * asked to accept the pairing request. If the IO capability is set to 153 * SSP_IO_CAPABILITY_DISPLAY_YES_NO, the request will be automatically accepted. 154 * 155 * The RFCOMM_EVENT_INCOMING_CONNECTION event indicates an incoming connection. 156 * Here, the connection is accepted. More logic is need, if you want to handle connections 157 * from multiple clients. The incoming RFCOMM connection event contains the RFCOMM 158 * channel number used during the SPP setup phase and the newly assigned RFCOMM 159 * channel ID that is used by all BTstack commands and events. 160 * 161 * If RFCOMM_EVENT_CHANNEL_OPENED event returns status greater then 0, 162 * then the channel establishment has failed (rare case, e.g., client crashes). 163 * On successful connection, the RFCOMM channel ID and MTU for this 164 * channel are made available to the heartbeat counter. After opening the RFCOMM channel, 165 * the communication between client and the application 166 * takes place. In this example, the timer handler increases the real counter every 167 * second. 168 * 169 * RFCOMM_EVENT_CAN_SEND_NOW indicates that it's possible to send an RFCOMM packet 170 * on the rfcomm_cid that is include 171 172 */ 173 174 /* LISTING_START(SppServerPacketHandler): SPP Server - Heartbeat Counter over RFCOMM */ 175 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 176 UNUSED(channel); 177 UNUSED(size); 178 179 /* LISTING_PAUSE */ 180 bd_addr_t event_addr; 181 182 switch (packet_type) { 183 case HCI_EVENT_PACKET: 184 switch (hci_event_packet_get_type(packet)) { 185 /* LISTING_RESUME */ 186 case HCI_EVENT_PIN_CODE_REQUEST: 187 // inform about pin code request 188 log_info("Pin code request - using '0000'\n"); 189 hci_event_pin_code_request_get_bd_addr(packet, event_addr); 190 gap_pin_code_response(event_addr, "0000"); 191 break; 192 193 case HCI_EVENT_USER_CONFIRMATION_REQUEST: 194 // ssp: inform about user confirmation request 195 log_info("SSP User Confirmation Request with numeric value '%06"PRIu32"'\n", little_endian_read_32(packet, 8)); 196 log_info("SSP User Confirmation Auto accept\n"); 197 break; 198 199 case RFCOMM_EVENT_INCOMING_CONNECTION: 200 // data: event (8), len(8), address(48), channel (8), rfcomm_cid (16) 201 rfcomm_event_incoming_connection_get_bd_addr(packet, event_addr); 202 rfcomm_channel_id = rfcomm_event_incoming_connection_get_rfcomm_cid(packet); 203 rfcomm_accept_connection(rfcomm_channel_id); 204 break; 205 206 case RFCOMM_EVENT_CHANNEL_OPENED: 207 // data: event(8), len(8), status (8), address (48), server channel(8), rfcomm_cid(16), max frame size(16) 208 if (rfcomm_event_channel_opened_get_status(packet)) { 209 log_info("RFCOMM channel open failed, status %u\n", rfcomm_event_channel_opened_get_status(packet)); 210 } else { 211 rfcomm_channel_id = rfcomm_event_channel_opened_get_rfcomm_cid(packet); 212 } 213 break; 214 case RFCOMM_EVENT_CAN_SEND_NOW: 215 rfcomm_send(rfcomm_channel_id, (uint8_t*) lineBuffer, strlen(lineBuffer)); 216 break; 217 218 /* LISTING_PAUSE */ 219 case RFCOMM_EVENT_CHANNEL_CLOSED: 220 log_info("RFCOMM channel closed\n"); 221 rfcomm_channel_id = 0; 222 break; 223 224 default: 225 break; 226 } 227 break; 228 229 case RFCOMM_DATA_PACKET: 230 break; 231 232 default: 233 break; 234 } 235 /* LISTING_RESUME */ 236 } 237 /* LISTING_END */ 238 239 int btstack_main(int argc, const char * argv[]); 240 int btstack_main(int argc, const char * argv[]){ 241 (void)argc; 242 (void)argv; 243 244 one_shot_timer_setup(); 245 spp_service_setup(); 246 247 gap_discoverable_control(1); 248 gap_ssp_set_io_capability(SSP_IO_CAPABILITY_DISPLAY_YES_NO); 249 gap_set_local_name("SPP Counter 00:00:00:00:00:00"); 250 251 // turn on! 252 hci_power_control(HCI_POWER_ON); 253 254 return 0; 255 } 256 /* EXAMPLE_END */ 257 258