Skip to content

Commit 420d90d

Browse files
zafersnzafersn
committed
boards: shields: add swir_hl78xx_ev kit
add support for HL78xx driver Signed-off-by: Zafer SEN <[email protected]>
1 parent 8b00f61 commit 420d90d

File tree

11 files changed

+251
-0
lines changed

11 files changed

+251
-0
lines changed

‎boards/shields/swir_hl78xx_ev_kit/Kconfig.shield‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Copyright (c) 2025 Netfeasa Ltd.
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
config SHIELD_SWIR_HL78XX_EV_KIT
5+
def_bool $(shields_list_contains,swir_hl78xx_ev_kit)

‎boards/shields/swir_hl78xx_ev_kit/doc/img/SW-Dev-RC76.3.webp‎

98.3 KB
Loading

‎boards/shields/swir_hl78xx_ev_kit/doc/index.rst‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
.. _swir_hl78xx_ev_kit:
2+
3+
HL/RC Module Evaluation Kit Shield
4+
##################################
5+
6+
Overview
7+
********
8+
9+
Welcome to the HL78 module getting started guide.
10+
This guide will help you set up the evaluation kit (eval kit)
11+
for sending AT commands to the HL78 module and initiating data transmission.
12+
13+
.. figure:: img/SW-Dev-RC76.3.webp
14+
:align: center
15+
:alt: HL/RC Module Evaluation Kit Shield Shield
16+
17+
HL/RC Module Evaluation Kit Shield Shield (Credit: Sierrra Wireless)
18+
19+
More information about the shield can be found at the `HL/RC Module Evaluation Kit Shield guide website`_.
20+
21+
Pins Assignment of HL/RC Module Evaluation Kit Shield Shield
22+
============================================================
23+
+--------------------------+----------------------------------------------------------+
24+
| Shield Connector Pin | Function |
25+
+==========================+==========================================================+
26+
| CN403 alias | UART 1 (with CTS and RTS pins) |
27+
+--------------------------+----------------------------------------------------------+
28+
| CN303 alias | SPI / UART 3 |
29+
+--------------------------+----------------------------------------------------------+
30+
| CN1000 alias | GPIO Test Pins |
31+
+--------------------------+----------------------------------------------------------+
32+
| GPIO6 CN1000_3 | LOW POWER MONITORING |
33+
+--------------------------+----------------------------------------------------------+
34+
| VGPIO alias | Indirect indicator of hibernate mode entry/exit |
35+
+--------------------------+----------------------------------------------------------+
36+
| RESET CN1000_12 | RESET SIGNAL |
37+
+--------------------------+----------------------------------------------------------+
38+
| WAKE-UP CN1000_8 | SPI / UART 3 |
39+
+--------------------------+----------------------------------------------------------+
40+
41+
Please refer to the website for more information about HL/RC Module Evaluation Kit Shield Shield setup.
42+
.. _HL/RC Module Evaluation Kit Shield guide website:
43+
44+
Checking Your Basic Configurations in PuTTY
45+
===========================================
46+
Before trying to set up a wired connection between the board and a host MCU,
47+
it's a good idea to first go through this list of basic AT commands over a
48+
USB COM port on a PC. For reference, you can find all the AT commands for the
49+
HL78xx modules in the Source.
50+
51+
Requirements
52+
************
53+
54+
This shield can be used with any boards which provides a configuration for
55+
header connectors and defines node aliases for UART, SPI and USB interfaces (see
56+
:ref:`shields` for more details).
57+
58+
Programming
59+
***********
60+
61+
Set ``--shield swir_hl78xx_ev_kit`` when you invoke ``west build``. For
62+
example:
63+
64+
.. zephyr-app-commands::
65+
:zephyr-app: samples/drivers/modem/hello_hl78xx
66+
:board: st/nucleo_u575zi_q
67+
:shield: swir_hl78xx_ev_kit
68+
:goals: build
69+
70+
References
71+
**********
72+
73+
.. target-notes::
74+
75+
.. _HL/RC Module Evaluation Kit Shield guide website:
76+
https://source.sierrawireless.com/resources/airprime/development_kits/hl78xx-hl7900-development-kit-guide/
77+
78+
.. _HL/RC Module Evaluation Kit Shield specification website:
79+
https://info.sierrawireless.com/iot-modules-evaluation-kit#guide-for-the-hl78-series-evaluation-kit

‎boards/shields/swir_hl78xx_ev_kit/shield.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
shield:
2+
name: swir_hl78xx_ev_kit
3+
full_name: Sierra Wireless HL/RC Module Evaluation Kit
4+
vendor: Sierra Wireless
5+
supported_features:
6+
- modem

‎boards/shields/swir_hl78xx_ev_kit/swir_hl78xx_ev_kit.overlay‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* Copyright (c) 2025 Netfeasa Ltd.
3+
*
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
/ {
8+
aliases {
9+
modem-uart = &usart2;
10+
modem = &modem;
11+
gnss = &gnss;
12+
};
13+
};
14+
15+
&usart2 {
16+
pinctrl-0 = <&usart2_tx_pa2 &usart2_rx_pa3 &usart2_rts_pd4 &usart2_cts_pd3>;
17+
pinctrl-1 = <&analog_pa2 &analog_pa3 &analog_pd4 &analog_pd3>;
18+
dmas = <&gpdma1 0 27 STM32_DMA_PERIPH_TX
19+
&gpdma1 1 26 STM32_DMA_PERIPH_RX>;
20+
dma-names = "tx", "rx";
21+
pinctrl-names = "default", "sleep";
22+
current-speed = <115200>;
23+
status = "okay";
24+
hw-flow-control;
25+
modem: hl_modem {
26+
compatible = "swir,hl7812";
27+
status = "okay";
28+
mdm-reset-gpios = <&gpiod 5 (GPIO_ACTIVE_LOW)>;
29+
socket_offload: socket_offload {
30+
compatible = "swir,hl7812-offload";
31+
status = "okay";
32+
/* optional properties for future: */
33+
max-data-length = <512>;
34+
};
35+
gnss: hl_gnss {
36+
compatible = "swir,hl7812-gnss";
37+
pps-mode = "GNSS_PPS_MODE_DISABLED";
38+
fix-rate = <1000>;
39+
status = "okay";
40+
};
41+
};
42+
43+
};

‎dts/bindings/modem/swir,hl7812-gnss.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
description: |
2+
Binding for a modem offload child node that indicates the modem
3+
supports socket offload functionality. This node is intended to be a
4+
child of a modem device node (for example, `modem: hl_modem { ... };`).
5+
6+
The binding is intentionally small and extensible; it documents a
7+
presence node (compatible = "swir,hl7812-offload") and may be extended
8+
in future with additional properties that the driver may consume.
9+
10+
compatible: "swir,hl7812-gnss"
11+
12+
include: swir,hl78xx-gnss.yaml

‎dts/bindings/modem/swir,hl7812-offload.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copyright (c) 2025, Netfeasa Ltd.
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
description: Sierra Wireless HL7812 Modem offload
5+
6+
compatible: "swir,hl7812-offload"
7+
8+
include: swir,hl78xx-offload.yaml

‎dts/bindings/modem/swir,hl7812.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Copyright (c) 2025, Netfeasa Ltd.
2+
# SPDX-License-Identifier: Apache-2.0
3+
4+
description: Sierra Wireless HL7812 Modem
5+
6+
compatible: "swir,hl7812"
7+
8+
include: swir,hl78xx.yaml

‎dts/bindings/modem/swir,hl78xx-gnss.yaml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
description: |
2+
Binding for a modem child node that indicates the modem supports
3+
GNSS functionality. This node is intended to be a child of a modem
4+
device node (for example, `modem: hl_modem { ... };`).
5+
6+
The binding is intentionally small and extensible; it documents a
7+
presence node (compatible = "swir,hl78xx-gnss") and may be extended
8+
in future with additional properties that the driver may consume.
9+
10+
compatible: "swir,hl78xx-gnss"
11+
12+
include:
13+
- uart-device.yaml
14+
- gnss-nmea-generic.yaml
15+
- gnss-pps.yaml
16+
17+
properties:
18+
fix-rate:
19+
type: int
20+
default: 1000
21+
description: |
22+
Initial fix-rate GNSS modem will be operating on. May be adjusted at
23+
run-time through GNSS APIs. Must be greater than 50-ms.
24+
Default is power-on setting.

‎dts/bindings/modem/swir,hl78xx-offload.yaml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
description: |
2+
Binding for a modem child node that indicates the modem supports
3+
socket offloading. This node is intended to be a child of a modem
4+
device node (for example, `modem: hl_modem { ... };`).
5+
6+
The binding is intentionally small and extensible; it documents a
7+
presence node (compatible = "net,offload-modem-sockets") and a couple
8+
of optional integer properties that the driver may consume.
9+
10+
compatible: "swir,hl78xx-offload"
11+
12+
properties:
13+
max-data-length:
14+
type: int
15+
description: |
16+
"Maximum length of a single data payload (bytes) that
17+
the modem can send/receive in one offload operation."
18+
enum:
19+
- 512
20+
- 1024
21+
- 2048
22+
- 4096
23+
- 8192
24+
25+
offload-priority:
26+
type: int
27+
description: |
28+
"Priority of this offload modem compared to other offload
29+
modems in the system. Lower values indicate higher priority.
30+
The system will prefer to use the offload modem with the
31+
highest priority (lowest value) when multiple offload modems
32+
are available."

0 commit comments

Comments
 (0)