xref: /btstack/port/stm32-l451-miromico-sx1280/README.md (revision d42180bbda46eb526d460bdea01321837cb04af6)
1*d42180bbSMatthias Ringwald# BTstack port with Cinnamon for Semtech SX1280 2.4 GHz Multi Protocol Controller
2*d42180bbSMatthias Ringwald
3*d42180bbSMatthias Ringwald*Cinnamon* is BlueKitchen's minimal, yet robust Controller/Link Layer implementation for use with BTstack.
4*d42180bbSMatthias Ringwald
5*d42180bbSMatthias RingwaldIn contrast to common Link Layer implementations, our focus is on a robust and compact implementation for production use,
6*d42180bbSMatthias Ringwaldwhere code size matters (e.g. current code size about 8 kB).
72fd737d3SMatthias Ringwald
82fd737d3SMatthias Ringwald## Overview
92fd737d3SMatthias Ringwald
102fd737d3SMatthias RingwaldThis port targets the Semtech SX1280 radio controller. The Host Stack and the Controller (incl. Link Layer) run on a STM32 MCU, with the SX1280 connected via SPI.
112fd737d3SMatthias Ringwald
12f508b9c4SMatthias RingwaldIt uses the SX1280 C-Driver from Semtech to communicate with the SX1280. The main modification was to the SPI driver that uses DMA for full packets.
132fd737d3SMatthias Ringwald
142fd737d3SMatthias Ringwald## Status
152fd737d3SMatthias Ringwald
162fd737d3SMatthias RingwaldOnly tested with the Miromico FMLR-80-P-STL4E module so far. On this module, the 52 Mhz clock for the SX1280 is controlled by the MCU.
172fd737d3SMatthias Ringwald
18f508b9c4SMatthias RingwaldSEGGER RTT is used for debug output, so a Segger J-Link programmer is required.
192fd737d3SMatthias Ringwald
202fd737d3SMatthias RingwaldUses 32.768 kHz crytstal as LSE for timing
212fd737d3SMatthias Ringwald
22f508b9c4SMatthias RingwaldSupport for Broadcast and Peripheral roles.
232fd737d3SMatthias Ringwald
242fd737d3SMatthias RingwaldThe Makefile project compiles gatt_counter, gatt_streamer_server, hog_mouse and hog_keyboard examples.
252fd737d3SMatthias Ringwald
262fd737d3SMatthias Ringwald## Limitation
272fd737d3SMatthias Ringwald
282fd737d3SMatthias Ringwald### Advertising State:
292fd737d3SMatthias Ringwald- Only Connectable Advertising supported
302fd737d3SMatthias Ringwald- Only fixed public BD_ADDR of 33:33:33:33:33:33 is used
312fd737d3SMatthias Ringwald
322fd737d3SMatthias Ringwald### Connection State:
332fd737d3SMatthias Ringwald- Encryption not implemented
342fd737d3SMatthias Ringwald- Some LL PDUs not supported
352fd737d3SMatthias Ringwald
362fd737d3SMatthias Ringwald### Central Role:
372fd737d3SMatthias Ringwald- Not implemented
382fd737d3SMatthias Ringwald
392fd737d3SMatthias Ringwald### Observer Role:
402fd737d3SMatthias Ringwald- Not implemented
412fd737d3SMatthias Ringwald
422fd737d3SMatthias Ringwald### Low power mode - basically not implemented:
432fd737d3SMatthias Ringwald- MCU does not sleep
442fd737d3SMatthias Ringwald- SPI could be disabled during sleep
45f508b9c4SMatthias Ringwald- 1 ms SysTick is used for host stack although 16-bit tick time is provided by LPTIM1 based on 32768 Hz LSE.
462fd737d3SMatthias Ringwald
472fd737d3SMatthias Ringwald## Getting Started
482fd737d3SMatthias Ringwald
492fd737d3SMatthias RingwaldFor the FMLR-80-P-STL4E module, just run make. You can upload the EXAMPLE.elf file created in build folder,
502fd737d3SMatthias Ringwalde.g. with Ozone using the provided EXAMPLE.jdebug, and run it.
512fd737d3SMatthias Ringwald
522fd737d3SMatthias Ringwald## TODO
532fd737d3SMatthias Ringwald
542fd737d3SMatthias Ringwald### General
552fd737d3SMatthias Ringwald- indicate random address in advertising pdus
56f508b9c4SMatthias Ringwald- allow to set random BD_ADDR via HCI command and use in Advertisements
57f508b9c4SMatthias Ringwald- support other regular adv types
582fd737d3SMatthias Ringwald- handle Encryption
592fd737d3SMatthias Ringwald
602fd737d3SMatthias Ringwald## Low Power
612fd737d3SMatthias Ringwald- enter STANDY_RC mode when idle
622fd737d3SMatthias Ringwald- implement MCU sleep (if next wakeup isn't immediate)
632fd737d3SMatthias Ringwald- sleep after connection request until first packet from Central
642fd737d3SMatthias Ringwald- replace SysTick with tick counter based on LPTIM1
652fd737d3SMatthias Ringwald- disable SPI on MCU sleep
662fd737d3SMatthias Ringwald
67