1.. zephyr:board:: actinius_icarus_bee
2
3Overview
4********
5
6The Icarus Bee is a cellular IoT board in Bee/xBee form factor.
7It is built around Nordic Semi's nRF9160 modem and combines
8LTE-M, NB-IoT, GPS, accelerometer, SPI Flash, RGB LED, Button,
9as well as an eSIM and a nano SIM connector.
10
11The main uController is the Nordic Semiconductor nRF9160, with
12ARM Cortex-M33F CPU, ARMv8-M Security Extension and the
13following devices (provided directly by Nordic):
14
15* :abbr:`ADC (Analog to Digital Converter)`
16* CLOCK
17* FLASH
18* :abbr:`GPIO (General Purpose Input Output)`
19* :abbr:`I2C (Inter-Integrated Circuit)`
20* :abbr:`MPU (Memory Protection Unit)`
21* :abbr:`NVIC (Nested Vectored Interrupt Controller)`
22* :abbr:`PWM (Pulse Width Modulation)`
23* :abbr:`RTC (nRF RTC System Clock)`
24* Segger RTT (RTT Console)
25* :abbr:`SPI (Serial Peripheral Interface)`
26* :abbr:`UARTE (Universal asynchronous receiver-transmitter with EasyDMA)`
27* :abbr:`WDT (Watchdog Timer)`
28* :abbr:`IDAU (Implementation Defined Attribution Unit)`
29
30.. figure:: img/icarus-bee-external-pins.jpg
31     :align: center
32     :alt: Icarus Bee w/ Pinouts
33
34     Icarus Bee w/ Pinouts
35
36.. figure:: img/icarus-bee-peripherals-pins.jpg
37     :align: center
38     :alt: Icarus Bee
39
40     Internal Pinouts
41
42Hardware
43********
44
45The detailed information about the on-board hardware can be found at the `Icarus Bee Product Website`_.
46
47Supported Features
48==================
49
50The actinius_icarus_bee board configuration supports the following
51hardware features:
52
53+-----------+------------+----------------------+
54| Interface | Controller | Driver/Component     |
55+===========+============+======================+
56| ADC       | on-chip    | adc                  |
57+-----------+------------+----------------------+
58| CLOCK     | on-chip    | clock_control        |
59+-----------+------------+----------------------+
60| FLASH     | on-chip    | flash                |
61+-----------+------------+----------------------+
62| GPIO      | on-chip    | gpio                 |
63+-----------+------------+----------------------+
64| I2C(M)    | on-chip    | i2c                  |
65+-----------+------------+----------------------+
66| MPU       | on-chip    | arch/arm             |
67+-----------+------------+----------------------+
68| NVIC      | on-chip    | arch/arm             |
69+-----------+------------+----------------------+
70| PWM       | on-chip    | pwm                  |
71+-----------+------------+----------------------+
72| SPI(M/S)  | on-chip    | spi                  |
73+-----------+------------+----------------------+
74| SPU       | on-chip    | system protection    |
75+-----------+------------+----------------------+
76| UARTE     | on-chip    | serial               |
77+-----------+------------+----------------------+
78| ACCEL     | st         | lis2dh               |
79+-----------+------------+----------------------+
80
81SIM selection
82*************
83
84The sim choice (eSIM or nano-SIM) can be configured in Devicetree by adjusting
85the ``sim`` property in the ``sim_select`` node.
86
87Security components
88===================
89
90- Implementation Defined Attribution Unit (`IDAU`_).  The IDAU is implemented
91  with the System Protection Unit and is used to define secure and non-secure
92  memory maps.  By default, all of the memory space  (Flash, SRAM, and
93  peripheral address space) is defined to be secure accessible only.
94- Secure boot.
95
96Building Secure/Non-Secure Zephyr applications
97==============================================
98
99The process requires the following steps:
100
1011. Build the Secure Zephyr application using ``-DBOARD=actinius_icarus_bee``.
1022. Build the Non-Secure Zephyr application using ``-DBOARD=actinius_icarus_bee/ns``.
1033. Merge the two binaries together.
104
105If you are using Segger Embedded Studio v4.18 or later, the two binaries are built, merged, and
106burned automatically, unless you have disabled the feature.
107
108When building a Secure/Non-Secure application, the Secure application will
109have to set the IDAU (SPU) configuration to allow Non-Secure access to all
110CPU resources utilized by the Non-Secure application firmware. SPU
111configuration shall take place before jumping to the Non-Secure application.
112
113More information can be found in the `Icarus Bee Product Website`_ or the
114`Actinius Documentation Portal`_.
115
116References
117**********
118
119.. target-notes::
120
121.. _IDAU:
122   https://developer.arm.com/docs/100690/latest/attribution-units-sau-and-idau
123
124.. _Icarus Bee Product Website:
125   https://www.actinius.com/icarus-bee
126
127.. _Actinius Documentation Portal:
128   https://docs.actinius.com
129