1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

boards/firefly: use doc.txt for documentation

This commit is contained in:
Gunar Schorcht 2020-03-04 13:09:42 +01:00
parent 5982ba0c37
commit 3d07bb969a
2 changed files with 46 additions and 36 deletions

View File

@ -1,50 +1,59 @@
/**
* @defgroup boards_firefly Firefly Board
* @ingroup boards
* @brief Support for the Firefly board
Zolertia Firefly platform
============================================
\htmlonly<style>div.image img[src="http://i.imgur.com/m2acovV.png?1"]
{width:400px;}</style>\endhtmlonly
@image html "http://i.imgur.com/m2acovV.png?1" "Firefly"
The Firefly platform (Revision A) is a IoT Hardware development platform based
on TI's CC2538 system on chip (SoC), featuring an ARM Cortex-M3 with 512KB
flash, 32Kb RAM, double RF interface (Sub-1GHz CC1200 RF transceiver), and the
following goodies:
* ISM 2.4-GHz IEEE 802.15.4 & Zigbee compliant.
* ISM 868-, 915-, 920-, 950-MHz ISM/SRD Band.
* AES-128/256, SHA2 Hardware Encryption Engine.
* ECC-128/256, RSA Hardware Acceleration Engine for Secure Key Exchange.
* Power consumption down to 150nA using our shutdown mode.
* Flashing over BSL without requiring to press any button to enter bootloader mode.
* Built-in battery charger (500mA), Energy Harvesting and Solar Panels to be connected to standards LiPo batteries.
* Power input with 2.3-5.1VDC depending on battery or USB supply
- ISM 2.4-GHz IEEE 802.15.4 & Zigbee compliant.
- ISM 868-, 915-, 920-, 950-MHz ISM/SRD Band.
- AES-128/256, SHA2 Hardware Encryption Engine.
- ECC-128/256, RSA Hardware Acceleration Engine for Secure Key Exchange.
- Power consumption down to 150nA using our shutdown mode.
- Flashing over BSL without requiring to press any button to enter bootloader mode.
- Built-in battery charger (500mA), Energy Harvesting and Solar Panels to be connected to standards LiPo batteries.
- Power input with 2.3-5.1VDC depending on battery or USB supply
Port Features
=============
In terms of hardware support, the following drivers have been implemented:
In terms of hardware support, the following drivers have been implemented for
the CC2538 System-on-Chip:
* CC2538 System-on-Chip:
* UART
* Random number generator
* Low Power Modes
* General-Purpose Timers
* I2C/SPI library
* LEDs
* Buttons
* RF 2.4GHz built-in in CC2538
- UART
- Random number generator
- Low Power Modes
- General-Purpose Timers
- I2C/SPI library
- LEDs
- Buttons
- RF 2.4GHz built-in in CC2538
And under work or pending at cc2538 base cpu:
And under work or pending at CC2538 base CPU:
* Built-in core temperature and battery sensor.
* CC1200 sub-1GHz radio interface.
* Micro-SD external storage.
* ADC
* USB (in CDC-ACM).
* uDMA Controller.
- Built-in core temperature and battery sensor.
- CC1200 sub-1GHz radio interface.
- Micro-SD external storage.
- ADC
- USB (in CDC-ACM).
- uDMA Controller.
Requirements
============
* Toolchain to compile RIOT for the CC2538
* Drivers to enable your host to communicate with the platform
* Built-in BSL programming over USB using cc2538-bsl (included)
- Toolchain to compile RIOT for the CC2538
- Drivers to enable your host to communicate with the platform
- Built-in BSL programming over USB using cc2538-bsl (included)
Install a Toolchain
@ -67,7 +76,7 @@ Else install from <https://launchpad.net/gcc-arm-embedded>
Drivers
-------
The Firefly features a CP2104 serial-to-USB module, the driver is commonly found in most OS, but if required it can be downloaded
from <https://www.silabs.com/products/mcu/Pages/USBtoUARTBridgeVCPDrivers.aspx>
from <https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers>
### For the CC2538EM (USB CDC-ACM)
@ -95,17 +104,19 @@ On OS X, `/dev/tty.SLAB_USBtoUARTx`.
On Linux:
* Firefly over CP2104: `ttyUSB0`
* Firefly over USB driver (in CDC-ACM): `ttyACMn` (n=0, 1, ....)
- Firefly over CP2104: `ttyUSB0`
- Firefly over USB driver (in CDC-ACM): `ttyACMn` (n=0, 1, ....)
More Reading
============
1. [Zolertia Firefly website][remote-site]
2. [Zolertia Wiki page][zolertia-wiki]
2. [CC2538 System-on-Chip Solution for 2.4-GHz IEEE 802.15.4 and ZigBee applications (SWRU319B)][cc2538]
3. [CC1200 sub-1GHz RF transceiver][cc1200]
3. [CC2538 System-on-Chip Solution for 2.4-GHz IEEE 802.15.4 and ZigBee applications (SWRU319B)][cc2538]
4. [CC1200 sub-1GHz RF transceiver][cc1200]
[remote-site]: http://www.zolertia.io/products "Zolertia Firefly"
[remote-site]: https://zolertia.io/product/firefly "Zolertia Firefly"
[zolertia-wiki]: https://github.com/Zolertia/Resources/wiki
[cc1200]: http://www.ti.com/product/cc1200 "CC1200"
[cc2538]: http://www.ti.com/product/cc2538 "CC2538"
*/

View File

@ -7,8 +7,7 @@
*/
/**
* @defgroup boards_firefly Firefly Board
* @ingroup boards
* @ingroup boards_firefly
* @brief Support for the Firefly board
* @{
*