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