SlideShare a Scribd company logo

Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT

Jian-Hong Pan, profile picture
Jian-Hong Pan

The document discusses the implementation of an IEEE 802.15.4 driver for the SX1278 LoRa transceiver on Linux, detailing hardware specifics, programming strategies, and device driver architecture. It covers various protocols and operations involved in low-rate wireless personal area networks (LR-WPANs) and low-power wide-area networks (LPWANs), including the use of SPI communication and device tree settings. The summary includes technical references, hardware specifications, and a description of the driver's initialization, operation, and removal procedures.

Technology
1 of 79
Downloaded 126 times
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Most read
18
19
20
21
22
Most read
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
Most read
77
78
79
Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT SX1278 Transceiver in LoRa Mode for Example Jian-Hong Pan (StarNight) @ 2017.11.28 Taiwan Linux Kernel Hackers
Outline ● History ● OSI 7 Layers ○ LoRa / LoRaWAN ○ IEEE 802.15.4 ● Hardware ○ LoRa Transceiver ■ State Machine ■ FIFO Data Buffer ● Approaches ○ File Operations ○ IEEE 802.15.4 ● Driver Implementaion ○ Used APIs in Driver ○ The Driver Introduction ○ Device Tree & Tests ● Summary
Who am I 潘建宏 / Jian-Hong Pan (StarNight) I come from Taiwan ! You can find me at ～ http://www.slideshare.net/chienhungpan/ GitHub : starnight Facebook : Jian-Hong Pan Email : starnight [AT] g.ncu.edu.tw
History ● The Physics of the IoT ○ by David Mikolas @ Taipei.py 2016.06.30 ○ https://www.youtube.com/watch?v=iVlXt6RbgCE#t=18m30s ● 科技農夫陳幸延──農田裡的開源自造者 ○ The Scientific Farmer, Yan -- A Maker in the Farm ○ by 顏理謙, BUSINESS NEXT - 2016.06.10 ● Location Aware Sensor System (LASS) ○ LASS環境感測網路系統 http://lass-net.org/ ● 【科技農夫共創微氣候新農耕模式】年輕小農靠開源翻轉傳 統農業 ○ [Scientific farmers creates the new farming methods and utensils] Young farmers strengthen traditional agriculture with Open Source ○ by 何維涓, iThome - 2017.08.19
Wireless Technology ● Features ○ Long distance (coverage) ○ Short data message ○ Power consumption issue ● Low-Rate Wireless Personal Area Networks (LR-WPANs) ○ IEEE 802.15.4 ● Low-Power Wide-Area Network (LPWAN) ○ LoRa ○ Ultra Narrow Band: ■ Sigfox, NB-IoT ... Gateway or Edge Internet End-Device End-Device End-Device Outdoor Wireless measurement / control
From LPWAN - The Benefits of LPWAN Technology vs Other IoT Connectivity Options, written by Calum McClelland on iotforall.com Bandwidth - Range of Wireless LoRa
OSI 7 Layers Reference: Wikipedia OSI model https://en.wikipedia.org/wiki/OSI_model Physical Data Link Network Transport Session Presentation Application HTTP Sockets HTML HTTP Web API TCP IP Link neighbors Controlled by Application Controlled by OS Electrics, Lines / Radio Socket APIs
LoRa LoRa is the physical (PHY) layer or the wireless modulation utilized to create the long range communication link. ● Chirp spread spectrum (CSS) radio modulation ● Good link budget ● Low data rate ● Could be quite low power consumption ● Radio frequency should be used according to regional laws Reference: LoRaWAN™ 101 – A Technical Introduction by LoRa Alliance - November, 2015 What is LoRa? by LINK LABS - February 14, 2015
Link Budget dbm TX Power RX Power TX Antenna RX Antenna Connector Connector Free Space distance
LoRaWAN LoRaWAN is a media access control (MAC) layer protocol for managing communication between LPWAN gateways and end-node devices, maintained by the LoRa Alliance. ● Star topology ● Uplink - Downlink ● Over LoRa or FSK Reference: Wikipedia LPWAN https://en.wikipedia.org/wiki/LPWAN LoRaWAN™ Specification V1.0.2 by LoRa Alliance - July, 2016, P.12 ● Classes ○ Class A: Base line ○ Class B: Beacon ○ Class C: Continuous
LoRa Physical Message Formats Preamble PHDR PHDR_CRC PHYPayload CRC Preamble PHDR PHDR_CRC PHYPayload Uplink Message: Downlink Message: Preamble, PHDR, PHDR_CRC and CRC are inserted by the radio transceiver Reference: LoRaWAN™ Specification V1.0.2 by LoRa Alliance - July, 2016, P.11
IEEE 802.15.4 IEEE 802.15.4 is a technical standard which defines the operation of low-rate wireless personal area networks (LR-WPANs). It specifies the physical (PHY) layer and media access control (MAC) for LR-WPANs. Reference: Wikipedia IEEE 802.15.4 https://en.wikipedia.org/wiki/IEEE_802.15.4 Cluster tree networkStar topology Peer to peer topology PAN Coordinator Full-Function Device (FFD) Reduced-Function Device (RFD)
Comparison LoRaWAN Star Topology LoRa Good Link Budget IEEE 802.15.4 MAC Cluster Tree Network IEEE 802.15.4 PHY Normal Link Budget Application Presentation Session Transport Network MAC Layer PHY Layer LR-WPAN LPWAN
Combine Both Advantages Application Presentation Session Transport Network MAC Layer IEEE 802.15.4 MAC Cluster Tree Network PHY Layer LoRa Good Link Budget TCP/UDP 6LoWPAN Socket APIs LoRa acts as an IEEE 802.15.4 PHY
Cluster Tree Network & Good Link Budget Internet PAN Coordinator Full-Function Device (FFD) Reduced-Function Device (FFD) LoRa Each node can have a IPv6 address, if it has 6LoWPAN
LoRa Transceiver Hardware SX127X SPI Main Board Raspberry Pi SPI_CE1 SPI BUS LoRa Transceiver SX127X SPI Main Board Raspberry Pi SPI_CE1 SPI BUS
Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT
One of LoRa Transceiver Semtech - SX1276/77/78/79 for example http://www.semtech.com/images/datasheet/sx1276.pdf ● 168 dB maximum link budget ● High sensitivity: down to -148 dBm ● LoRa and FSK/OOK mode ● SPI interface Part Number Frequency Range Spreading Factor Bandwidth Effective Bitrate Est. Sensitivity SX1276 137 - 1020 MHz 6 - 12 7.8 - 500 kHz .018 - 37.5 kbps -111 to -148 dBm SX1277 137 - 1020 MHz 6 - 9 7.8 - 500 kHz .011 - 37.5 kbps -111 to -139 dBm SX1278 137 - 525 MHz 6 - 12 7.8 - 500 kHz .018 - 37.5 kbps -111 to -148 dBm SX1279 137 - 960MHz 6 - 12 7.8 - 500 kHz .018 - 37.5 kbps -111 to -148 dBm
State Machine of SX127X Transceiver SLEEP STANDBY TX RXSINGLE Set by command Set by command TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Only focus on used states
SX127X Transceiver’s IRQ Flags Bit Flag 7 RxTimeout 6 RxDone 5 PayloadCrcError 4 ValidHeader 3 TxDone 2 CadDone 1 FhssChangeChannel 0 CadDetected Reference: Semtech SX1276/77/78/79 datasheet, P.111, Figure 8. LoRaTM Mode Register Map RegIrqFlags (0x12)
SX127X Transceiver Linux Device Driver ● File Operation Interface ○ https://github.com/starnight/LoRa/tree/file-ops ○ File + SPI ○ As a character device node: /dev/loraSPIX.X ○ read/write from/to the FIFO data buffer, ioctl sets transceiver’s parameter ● IEEE 802.15.4 Interface ○ https://github.com/starnight/LoRa ○ IEEE 802.15.4 MAC + SPI ○ As a WPAN network interface ○ socket with 6LoWPAN over IEEE 802.15.4 MAC
Used APIs in Driver ● SPI ○ The communication bus with SX127X transceiver ● regmap ○ The common wrapper of low rate buses, like SPI, I2 C ... ● IEEE 802.15.4 ○ The LR-WPAN module in kernel ● Timer & Interrupt ○ Used for polling the state of the transciver periodically ● workqueue ○ The work scheduled by timer interrupt service routine ○ The work should check and do some things according to the state of transceiver ● Spin lock ○ Lock the state flags in the driver of the transceiver ● Device Tree ○ Set parameters with the configuration in device tree, if Open Firmware is enabled
Flow Charts of Driver Module Init & Exit module_init register SX1278 as an SPI driver End unregister SX1278 SPI driver End module_exit
Register SX1278 as SPI Protocol Driver /* The SPI driver which acts as a protocol driver in this kernel module. */ static struct spi_driver sx1278_spi_driver = { .driver = { .name = __DRIVER_NAME, .owner = THIS_MODULE, #ifdef CONFIG_OF .of_match_table = of_match_ptr(sx1278_dt_ids), #endif #ifdef CONFIG_ACPI .acpi_match_table = ACPI_PTR(sx1278_acpi_ids), #endif }, .probe = sx1278_spi_probe, .remove = sx1278_spi_remove, .id_table = sx1278_spi_ids, }; /* Register SX1278 kernel module. */ module_spi_driver(sx1278_spi_driver); Note: spi_match_device Matched by Open Firmware Matched by ACPI Matched by SPI Bus Device Tree Macro
of, acpi, id _match_table /* The compatible chip array. */ #ifdef CONFIG_OF static const struct of_device_id sx1278_dt_ids[] = { { .compatible = "semtech,sx1276" }, { .compatible = "semtech,sx1277" }, { .compatible = "semtech,sx1278" }, { .compatible = "semtech,sx1279" }, { .compatible = "sx1278" }, {}, }; MODULE_DEVICE_TABLE(of, sx1278_dt_ids); #endif /* The compatible ACPI device array. */ #ifdef CONFIG_ACPI static const struct acpi_device_id sx1278_acpi_ids[] = { { .id = "sx1278" }, {}, }; MODULE_DEVICE_TABLE(acpi, sx1278_acpi_ids); #endif /* The compatible SPI device id array. */ static const struct spi_device_id sx1278_spi_ids[] = { { .name = "sx1278" }, {}, }; MODULE_DEVICE_TABLE(spi, sx1278_spi_ids);
Flow Chart of Probing an SPI Device Have a block of memory to hold the IEEE 802.15.4 compatible hardware Set the LoRa PHY as SPI deivce’s privata data End Probe an SPI device Have a regmap wrapper for the SPI bus to transceiver Set the RF channels & output power Set the IEEE 802.15.4 address Register the LoRa PHY as an IEEE 802.15.4 hardware Set the timer interrupt & the work going to be scheduled Initial the LoRa PHY sx1278_ieee_add_one
SPI Probe Device Callback Function static int sx1278_spi_probe(struct spi_device *spi) { struct ieee802154_hw *hw; struct sx1278_phy *phy; int err; hw = ieee802154_alloc_hw(sizeof(*phy), &sx1278_ops); ... phy = hw->priv; phy->hw = hw; hw->parent = &spi->dev; phy->map = devm_regmap_init_spi(spi, &sx1278_regmap_config); /* Set the SPI device's driver data for later usage. */ spi_set_drvdata(spi, phy); err = sx1278_ieee_add_one(phy); ... } Allocate a block of memory to hold the data of IEEE 802.15.4 compatible hardware
static const struct ieee802154_ops sx1278_ops = { .owner = THIS_MODULE, .xmit_async = sx1278_ieee_xmit, .ed = sx1278_ieee_ed, .set_channel = sx1278_ieee_set_channel, .set_txpower = sx1278_ieee_set_txpower, .start = sx1278_ieee_start, .stop = sx1278_ieee_stop, .set_promiscuous_mode = sx1278_ieee_set_promiscuous_mode, }; The entry points of IEEE 802.15.4 actions IEEE 802.15.4 Ops. of SX1278 Driver
struct sx1278_phy phy cfg802154_registered_device Block Memory of IEEE 802.15.4 Device struct wpan_phy wpan_phy struct ieee802154_local *local = wpan_phy.priv struct wpan_phy *phy ieee802154_ops *ops struct ieee802154_hw hw struct wpan_phy *phy void *priv struct device *parent struct regmap *map struct ieee802154_hw *hw sx1278_ops regmap device of SPI pointed by IEEE 802.15.4 module ieee802154_alloc_hw pointed by SX1278 driver sx1278_spi_probe
SPI Probe Device Callback Function static int sx1278_spi_probe(struct spi_device *spi) { struct ieee802154_hw *hw; struct sx1278_phy *phy; int err; hw = ieee802154_alloc_hw(sizeof(*phy), &sx1278_ops); ... phy = hw->priv; phy->hw = hw; hw->parent = &spi->dev; phy->map = devm_regmap_init_spi(spi, &sx1278_regmap_config); /* Set the SPI device's driver data for later usage. */ spi_set_drvdata(spi, phy); err = sx1278_ieee_add_one(phy); ... } Allocate a block of memory to hold the data of IEEE 802.15.4 compatible hardware Have a regmap wrapping the SPI bus to the transceiver Set the phy as the driver data of the SPI device
struct sx1278_phy struct sx1278_phy { struct ieee802154_hw *hw; struct regmap *map; bool suspended; u8 opmode; struct timer_list timer; struct work_struct irqwork; /* Lock the RX and TX actions. */ spinlock_t buf_lock; struct sk_buff *tx_buf; u8 tx_delay; bool one_to_be_sent; bool post_tx_done; bool is_busy; };
Register SX1278 as IEEE 802.15.4 PHY static int sx1278_ieee_add_one(struct sx1278_phy *phy) { struct ieee802154_hw *hw = phy->hw; int err; /* Define channels could be used. */ hw->phy->supported.channels[0] = sx1278_ieee_channel_mask(hw); /* SX1278 phy channel 11 as default */ hw->phy->current_channel = 11; /* Define RF power. */ hw->phy->supported.tx_powers = sx1278_powers; hw->phy->supported.tx_powers_size = ARRAY_SIZE(sx1278_powers); hw->phy->transmit_power = sx1278_powers[12]; ieee802154_random_extended_addr(&hw->phy->perm_extended_addr); ... Set usable RF channels of the SX127X transceiver Set usable RF output powers of the SX127X transceiver Generates a random extended address of IEEE 802.15.4 MAC
Register SX1278 as IEEE 802.15.4 PHY Continue ... hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_RX_OMIT_CKSUM | IEEE802154_HW_PROMISCUOUS; err = ieee802154_register_hw(hw); ... INIT_WORK(&phy->irqwork, sx1278_timer_irqwork); init_timer(&phy->timer); phy->timer.expires = jiffies_64 + HZ; phy->timer.function = sx1278_timer_isr; phy->timer.data = (unsigned long)phy; spin_lock_init(&phy->buf_lock); err = init_sx127x(phy->map); ... } Do/Not do generate frame check sum Register SX1278 as an IEEE 802.15.4 PHY Bind the function to the work which is going to be scheduled by the timer ISR Initial settings of the timer including the timer ISR The argument phy going to be passed into timer ISR
Flow Chart of Probing an SPI Device Have the LoRa PHY from SPI device’s privata data End Remove an SPI device Delete and stop the timer Flush the work scheduled by timer ISR Unregister the IEEE 802.15.4 hardware Free the IEEE 802.15.4 hardware sx1278_ieee_delete
SPI Remove Device Callback Function static int sx1278_spi_remove(struct spi_device *spi) { struct sx1278_phy *phy = spi_get_drvdata(spi); sx1278_ieee_del(phy); return 0; } static void sx1278_ieee_del(struct sx1278_phy *phy) { if (!phy) return; del_timer(&phy->timer); flush_work(&phy->irqwork); ieee802154_unregister_hw(phy->hw); ieee802154_free_hw(phy->hw); } Get the phy from the SPI device’s driver data Stop timing and delete the timer Wait for irqwork to finish executing the last queueing instance Unregister and free the IEEE 802.15.4 compatible device
Polling the State of SX127X Periodically SLEEP STANDBY TX RXSINGLE Set by command Set by command TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Polling when Timer Interrupted !!!
Polling when Timer Interrupted 1. When to start the timer? a. The IEEE 802.15.4 interface is becoming up. 2. When to stop the timer? a. The IEEE 802.15.4 interface is becoming down. 3. Timer interrupt is an interrupt, so there should not be any long time block in the interrupt service routine. a. Polling the SX127X transceiver’s state will need SPI transferring. b. SPI locks the system when it is transfering the SPI message synchronously. c. Schedule a work to workqueue in timer’s interrupt service routine!!!
IEEE 802.15.4 Interface Up & Down static const struct ieee802154_ops sx1278_ops = { .owner = THIS_MODULE, .xmit_async = sx1278_ieee_xmit, .ed = sx1278_ieee_ed, .set_channel = sx1278_ieee_set_channel, .set_txpower = sx1278_ieee_set_txpower, .start = sx1278_ieee_start, .stop = sx1278_ieee_stop, .set_promiscuous_mode = sx1278_ieee_set_promiscuous_mode, }; ip link set <interface> up ip link set <interface> down
IEEE 802.15.4 Interface Up static int sx1278_ieee_start(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; dev_dbg(regmap_get_device(phy->map), "interface upn"); sx1278_ieee_set_channel(hw, 0, hw->phy->current_channel); phy->suspended = false; sx127X_start_loramode(phy->map); phy->opmode = sx127X_get_mode(phy->map); add_timer(&phy->timer); return 0; } Set the RF using channel and frequency Set the SX127X transceiver in LoRa mode Get the SX127X transceiver operating mode Enable timer
IEEE 802.15.4 Interface Down static void sx1278_ieee_stop(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; dev_dbg(regmap_get_device(phy->map), "interface downn"); phy->suspended = true; del_timer(&phy->timer); sx127X_set_state(phy->map, SX127X_SLEEP_MODE); } Disable timer Make the SX127X transceiver go to sleep
Schedule a work into workqueue in ISR static void sx1278_timer_isr(unsigned long arg) { struct sx1278_phy *phy = (struct sx1278_phy *)arg; schedule_work(&phy->irqwork); } Push the work into workqueue static void sx1278_timer_irqwork(struct work_struct *work) { struct sx1278_phy *phy; phy = container_of(work, struct sx1278_phy, irqwork); sx1278_ieee_statemachine(phy->hw); } Get container structure of work Do polling the SX127X’s state When the work is scheduled to be executing
Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command: sx1278_ieee_xmit register one new frame going to be sent TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY
Do Polling SX127X Transceiver’s State void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; u8 flags; u8 state; bool do_next_rx = false; flags = sx127X_get_loraallflag(phy->map); state = sx127X_get_state(phy->map); Should be one or composed of: ● SX127X_FLAG_RXTIMEOUT ● SX127X_FLAG_PAYLOADCRCERROR ● SX127X_FLAG_RXDONE ● SX127X_FLAG_TXDONE Should be one of: ● SX127X_SLEEP_MODE ● SX127X_STANDBY_MODE ● SX127X_TX_MODE ● SX127X_RXSINGLE_MODE
if (flags & (SX127X_FLAG_RXTIMEOUT | SX127X_FLAG_PAYLOADCRCERROR)) { sx127X_clear_loraflag(phy->map, SX127X_FLAG_RXTIMEOUT | SX127X_FLAG_PAYLOADCRCERROR | SX127X_FLAG_RXDONE); spin_lock(&phy->buf_lock); phy->is_busy = false; spin_unlock(&phy->buf_lock); do_next_rx = true; } else if (flags & SX127X_FLAG_RXDONE) { sx1278_ieee_rx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_RXDONE); do_next_rx = true; } Check the SX127X transceiver is receiving time out or CRC error Check the SX127X transceiver is already received a new frame
if (flags & SX127X_FLAG_TXDONE) { sx1278_ieee_tx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_TXDONE); phy->tx_delay = 10; do_next_rx = true; } if (phy->one_to_be_sent && (state == SX127X_STANDBY_MODE) && (phy->tx_delay == 0)) { if (!sx1278_ieee_tx(phy->hw)) do_next_rx = false; } Check the SX127X transceiver is already transmit a frame out Check the SX127X transceiver 1. Have a new frame going to be transmit 2. Can try to transmit the new frame a. Is not busy → standby b. Transmit delay is enough
if (do_next_rx) sx1278_ieee_rx(phy->hw); if (phy->tx_delay > 0) phy->tx_delay -= 1; if (!phy->suspended) { phy->timer.expires = jiffies_64 + 1; add_timer(&phy->timer); } } Ask transceiver try to do receiving again, if it is not busy Enable the timer again, if the interface is still enabled Wait for polling SX127X transceiver’s state next time Decrease the counter of transmission delay
Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command in sx1278_ieee_statemachine TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY sx1278_ieee_xmit register a new frame going to be sent
IEEE 802.15.4 Xmit static const struct ieee802154_ops sx1278_ops = { .owner = THIS_MODULE, .xmit_async = sx1278_ieee_xmit, .ed = sx1278_ieee_ed, .set_channel = sx1278_ieee_set_channel, .set_txpower = sx1278_ieee_set_txpower, .start = sx1278_ieee_start, .stop = sx1278_ieee_stop, .set_promiscuous_mode = sx1278_ieee_set_promiscuous_mode, }; ieee802154_tx in IEEE 802.15.4 module
Register a New Frame going to be Sent static int sx1278_ieee_xmit(struct ieee802154_hw *hw, struct sk_buff *skb) { struct sx1278_phy *phy = hw->priv; int ret; ... spin_lock(&phy->buf_lock); if (phy->tx_buf) { ret = -EBUSY; } else { phy->tx_buf = skb; phy->one_to_be_sent = true; phy->post_tx_done = false; ret = 0; } spin_unlock(&phy->buf_lock); return ret; } Check no pending frame going to be sent Register the new frame going to be sent
void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { ... if (flags & SX127X_FLAG_TXDONE) { sx1278_ieee_tx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_TXDONE); phy->tx_delay = 10; do_next_rx = true; } if (phy->one_to_be_sent && (state == SX127X_STANDBY_MODE) && (phy->tx_delay == 0)) { if (!sx1278_ieee_tx(phy->hw)) do_next_rx = false; } ... } Do Xmit a Frame during Polling State
Do Xmit a Frame int sx1278_ieee_tx(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; struct sk_buff *tx_buf = phy->tx_buf; bool do_tx = false; … if (!phy->post_tx_done) { sx127X_sendloradata(phy->map, tx_buf->data, tx_buf->len); phy->post_tx_done = true; } Prepare and write the new frame’s data to SX127X transceiver’s TX FIFO
Xmit a Frame after Fill SX127X TX FIFO spin_lock(&phy->buf_lock); if (!phy->is_busy) { phy->is_busy = true; do_tx = true; phy->one_to_be_sent = false; } spin_unlock(&phy->buf_lock); if (do_tx) { /* Set chip as TX state and transfer the data in FIFO. */ phy->opmode = (phy->opmode & 0xF8) | SX127X_TX_MODE; regmap_write_async(phy->map, SX127X_REG_OP_MODE, phy->opmode); return 0; } else { … return -EBUSY; } } Change the SX127X transceiver to TX state and start TX action
TX FIFO of SX127X Transceiver PayloadLength Reference: Semtech SX1276/77/78/79 datasheet, P.34, Figure 8. LoRaTM Data Buffer FifoTxBaseAddr SPI Read/WriteFifoAddrPtr 256 bytes FIFO
Filling SX127X Transceiver’s TX FIFO size_t sx127X_sendloradata(struct regmap *map, u8 *buf, size_t len) { u8 base_adr; u8 blen; /* Set chip FIFO pointer to FIFO TX base. */ base_adr = SX127X_FIFO_TX_BASE_ADDRESS; regmap_raw_write(map, SX127X_REG_FIFO_ADDR_PTR, &base_adr, 1); /* Write payload synchronously to fill the FIFO of the chip. */ blen = (len <= IEEE802154_MTU) ? len : IEEE802154_MTU; regmap_raw_write(map, SX127X_REG_FIFO, buf, blen); /* Set the FIFO payload length. */ regmap_raw_write(map, SX127X_REG_PAYLOAD_LENGTH, &blen, 1); return blen; } Set FIFO address going to write start with Fill TX payload in to FIFO Set TX payload length
void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { ... if (flags & SX127X_FLAG_TXDONE) { sx1278_ieee_tx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_TXDONE); phy->tx_delay = 10; do_next_rx = true; } if (phy->one_to_be_sent && (state == SX127X_STANDBY_MODE) && (phy->tx_delay == 0)) { if (!sx1278_ieee_tx(phy->hw)) do_next_rx = false; } ... } Xmit Finished during Polling State
Response Xmit a Frame is Finished static int sx1278_ieee_tx_complete(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; struct sk_buff *skb = phy->tx_buf; dev_dbg(regmap_get_device(phy->map), "%sn", __func__); ieee802154_xmit_complete(hw, skb, false); spin_lock(&phy->buf_lock); phy->is_busy = false; phy->tx_buf = NULL; spin_unlock(&phy->buf_lock); return 0; } Response to IEEE 802.15.4 module that the new frame is already sent
After transmits, transceiver also receives
Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command: sx1278_ieee_xmit register one new frame going to be sent TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY
void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { … if (do_next_rx) sx1278_ieee_rx(phy->hw); ... } Try to Receive during Polling State
Change SX127X to RX Mode int sx1278_ieee_rx(struct ieee802154_hw *hw) { … spin_lock(&phy->buf_lock); if (!phy->is_busy) { phy->is_busy = true; do_rx = true; } else { do_rx = false; } spin_unlock(&phy->buf_lock); if (do_rx) { sx127X_set_state(phy->map, SX127X_RXSINGLE_MODE); return 0; } else { … return -EBUSY; } } Change the SX127X transceiver to RX state and try to receive only one frame
Do Receive during Polling State void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { … if (flags & (SX127X_FLAG_RXTIMEOUT | SX127X_FLAG_PAYLOADCRCERROR)) { ... } else if (flags & SX127X_FLAG_RXDONE) { sx1278_ieee_rx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_RXDONE); do_next_rx = true; } ... }
RX FIFO of SX127X Transceiver LoRa Modem RegFifoRxCurrentAddr FifoRxBytesNb PayloadLength FifoRxBaseAddr Reference: Semtech SX1276/77/78/79 datasheet, P.34, Figure 8. LoRaTM Data Buffer FifoTxBaseAddr SPI Read/Write FifoAddrPtr 256 bytes FIFO
Do Receive a New Incoming Frame static int sx1278_ieee_rx_complete(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; struct sk_buff *skb; … s32 rssi; s32 range = SX1278_IEEE_ENERGY_RANGE; … skb = dev_alloc_skb(IEEE802154_MTU); … len = sx127X_get_loralastpktpayloadlen(phy->map); sx127X_readloradata(phy->map, skb_put(skb, len), len); /* LQI: IEEE 802.15.4-2011 8.2.6 Link quality indicator. */ rssi = sx127X_get_loralastpktrssi(phy->map); rssi = (rssi > 0) ? 0 : rssi; lqi = ((s32)255 * (rssi + range) / range) % 255; ieee802154_rx_irqsafe(hw, skb, lqi); ... } Allocate a sk_buff to hold a new coming frame Get last packet’s payload length Read last RX packet as the new coming frame Calculate the link quality indicator Tell IEEE 802.15.4 module that there is a new incoming frame
Reading SX127X Transceiver’s RX FIFO ssize_t sx127X_readloradata(struct regmap *map, u8 *buf, size_t len) { u8 start_adr; int ret; /* Set chip FIFO pointer to FIFO last packet address. */ start_adr = SX127X_FIFO_RX_BASE_ADDRESS; regmap_raw_write(map, SX127X_REG_FIFO_ADDR_PTR, &start_adr, 1); /* Read LoRa packet payload. */ len = (len <= IEEE802154_MTU) ? len : IEEE802154_MTU; ret = regmap_raw_read(map, SX127X_REG_FIFO, buf, len); return (ret >= 0) ? len : ret; } Set FIFO address going to read start with Read a received payload from RX FIFO
Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command: sx1278_ieee_xmit register one new frame going to be sent TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY
Load SX1278 as an SPI protocol driver with Device Tree configuration
Device Tree Overlay Example sx1278@0 { compatible = "semtech,sx1278"; spi-max-frequency = <15200>; reg = <0>; clock-frequency = <32000000>; center-carrier-frq = <434000000>; minimal-RF-channel = /bits/ 8 <11>; maximum-RF-channel = /bits/ 8 <11>; };
SX1278 Device Tree Properties ● Required properties: ○ compatible: should be "semtech,sx1276", "semtech,sx1277", "semtech,sx1278" or "semtech,sx1279" depends on your transceiver board ○ spi-max-frequency: maximal bus speed, should be set something under or equal 10000000 Hz ○ reg: the chipselect index ○ clock-frequency: the external crystal oscillator frequency in Hz of the transceiver ○ center-carrier-frq: the RF center carrier frequency in Hz ● Optional properties: ○ rf-bandwidth: the RF bandwidth in Hz ○ minimal-RF-channel: the minimal RF channel number ○ maximum-RF-channel: the maximum RF channel number ○ spreading-factor: the spreading factor of Chirp Spread Spectrum modulation
Have test applications over 6LoWPAN over SX1278
Client - Server Test Application These applications communicate through UDP/IPv6 socket in simple client-server model. Client Server Client send a data string to server Server send the capitalized data string to client Capitalized data string
6LoWPAN module & SX1278 driver Application ClientPresentation Session Transport UDP Network IPv6 MAC Layer IEEE 802.15.4 MAC PHY Layer LoRa Server UDP IPv6 IEEE 802.15.4 MAC LoRa SX1278 driver 6LoWPAN module socket
Have lowpan interface from wpan # Private Area Network ID panid="0xbeef" # Index of the wpan interface i=0 # Set the PANID of the wpan interface iwpan dev wpan${i} set pan_id $panid # Create a lowpan interface over the wpan interface ip link add link wpan${i} name lowpan${i} type lowpan # Bring up the wpan and lowpan interfaces ip link set wpan${i} up ip link set lowpan${i} up linux-wpan/wpan-tools: Userspace tools for Linux IEEE 802.15.4 stack iwpan: based on the wireless iw tool.
Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT
● Server ○ server <listening IPv6 address> <listening port> ● Client ○ client <src IPv6 address> <dst IPv6 address> <dst port> <data string>
Hardware for Demo LoRa Transceiver SX1276 SPI LoRa Transceiver SX1276 SPI Main Board Raspberry Pi SPI_CE0 SPI_CE1 SPI BUS
Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT
Summary ● LoRa is a Low Power Wide Area Network(LPWAN) communitcation technology. ● Here is an IEEE 802.15.4 MAC over LoRa PHY Linux device driver. ● Pros ○ 6LoWPAN support for IEEE 802.15.4 → IPv6 for each node ○ Extending the coverage area by cluster tree network with the LoRa long communication distance of each edge is possible ● Cons ○ Extremely low data rate ○ As an external kernel module, because it is not LoRaWAN over LoRa
Reference ● LoRaWAN™ What is it? ● LoRaWAN™ Specification V1.0.2 from LoRa™ Alliance ● Wikipedia - LPWAN ● IEEE Std 802.15.4-2015 from IEEE ● Wikipedia - IEEE 802.15.4 ● Semtech SX1276/77/78/79 datasheet ● Linux IEEE 802.15.4 Documentation ● Loopback IEEE 802.15.4 interface: fakelb.c
Thank you ~ Q & A

More Related Content

PPTX
Smart Lighting Using IOT
Shrikant Chandan
 
PDF
IOT Networks
Marc Nader
 
PPTX
5G Network: Requirements, Design Principles, Architectures, and Enabling Tech...
Sayed Chhattan Shah
 
PPTX
ESP8266 Wifi Nodemcu
creatjet3d labs
 
PPTX
peripheral interfacing
Tahrimur Rahman
 
PPTX
Zigbee Presentation
Maathu Michael
 
PDF
5G Network Architecture and Design
3G4G
 
PDF
Nb iot presentation
manoj pradhan
 
Smart Lighting Using IOT
Shrikant Chandan
 
IOT Networks
Marc Nader
 
5G Network: Requirements, Design Principles, Architectures, and Enabling Tech...
Sayed Chhattan Shah
 
ESP8266 Wifi Nodemcu
creatjet3d labs
 
peripheral interfacing
Tahrimur Rahman
 
Zigbee Presentation
Maathu Michael
 
5G Network Architecture and Design
3G4G
 
Nb iot presentation
manoj pradhan
 

What's hot (20)

PPTX
Iot architecture
Niranjan Kumar
 
PPTX
The Modern Telco Network: Defining The Telco Cloud
Marco Rodrigues
 
PDF
LPWAN technology overview
Jisc
 
PPT
SPI Bus Protocol
Sudhanshu Janwadkar
 
PPTX
Introduction to Internet of Things Hardware
Daniel Eichhorn
 
PDF
Communication protocols - Embedded Systems
Emertxe Information Technologies Pvt Ltd
 
PDF
Chapter 7
pavan penugonda
 
PPT
Memory organization of 8051
Muthu Manickam
 
PDF
IoT Based Weather Monitoring System for Effective Analytics
Ferdin Joe John Joseph PhD
 
PPTX
Sdn ppt
Pallavi Chhikara
 
PDF
6lowpan introduction
Martin Abraham
 
PDF
IoT Programming on the Raspberry Pi
Damien Magoni
 
PDF
Open v ran
Rajasa Pramudya Wardhana
 
PDF
Introduction to embedded system design
Mukesh Bansal
 
PDF
Low Power Wireless Technologies and Standards for the Internet of Things
Duncan Purves
 
PPTX
ZigBee Technology
Nimi T
 
PDF
5G + AI: The Ingredients For Next Generation Wireless Innovation
Qualcomm Research
 
PPTX
Introduction to SDN and NFV
CoreStack
 
PPT
Serial Peripheral Interface(SPI)
Dhaval Kaneria
 
PPTX
Raspberry Pi
Vijay Vishwakarma
 
Iot architecture
Niranjan Kumar
 
The Modern Telco Network: Defining The Telco Cloud
Marco Rodrigues
 
LPWAN technology overview
Jisc
 
SPI Bus Protocol
Sudhanshu Janwadkar
 
Introduction to Internet of Things Hardware
Daniel Eichhorn
 
Communication protocols - Embedded Systems
Emertxe Information Technologies Pvt Ltd
 
Chapter 7
pavan penugonda
 
Memory organization of 8051
Muthu Manickam
 
IoT Based Weather Monitoring System for Effective Analytics
Ferdin Joe John Joseph PhD
 
Sdn ppt
Pallavi Chhikara
 
6lowpan introduction
Martin Abraham
 
IoT Programming on the Raspberry Pi
Damien Magoni
 
Open v ran
Rajasa Pramudya Wardhana
 
Introduction to embedded system design
Mukesh Bansal
 
Low Power Wireless Technologies and Standards for the Internet of Things
Duncan Purves
 
ZigBee Technology
Nimi T
 
5G + AI: The Ingredients For Next Generation Wireless Innovation
Qualcomm Research
 
Introduction to SDN and NFV
CoreStack
 
Serial Peripheral Interface(SPI)
Dhaval Kaneria
 
Raspberry Pi
Vijay Vishwakarma
 
Ad

Similar to Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT (20)

PDF
LoRaWAN class module and subsystem
Jian-Hong Pan
 
PDF
IoT Connectivity with LoRa
Andri Yadi
 
PDF
The current state of LoRaWAN security
📡 Sebastien Dudek
 
PPTX
Brief LoRaWAN Overview
Alper Yegin
 
PDF
Open fest2018 LoRa, LoRa WAN, The Thing Network - capabilities, myths, applic...
Olimex Bulgaria
 
PPTX
Seeeduino LoRaWAN
Michele La Malva Moreno
 
PDF
LPWAN.pdf
EzioAuditore278720
 
PDF
Analysis of Energy Consumption in MCU for IoT System
IRJET Journal
 
PDF
Intro Lora - Makers.ID Meetup
Mif Masterz
 
PPTX
LoRa General Presentation FOR MASSIVE DEPLOYMENT.pptx
WidedAhmadi
 
PPTX
LoRa General Presentation FOR MASSIVE DEPLOYMENT.pptx
WidedAhmadi
 
PDF
LoRaPresentation20255555555555555555555555555555555555.pdf
WidedAhmadi
 
PDF
LoRa General Presentation LoRa General Presentation.pdf
ssuser262297
 
PPTX
Lorawan: What you need to know
Paul Coomans
 
PDF
Webinar: Tecnologia LoRa – Do dispositivo à nuvem
Embarcados
 
PDF
LORA BASED DATA ACQUISITION SYSTEM
IRJET Journal
 
PDF
Implementing lora smartcity doin
Jonny Doin
 
PDF
LPWAN London Meetup: Solving Urban Challenges
Digital Catapult
 
PPTX
Long-Range Low-power Radio (LoRa).pptx
Ajay Gangakhedkar
 
PDF
Low power wireless technologies for connecting embedded sensors in the IoT: A...
Gilles Callebaut
 
LoRaWAN class module and subsystem
Jian-Hong Pan
 
IoT Connectivity with LoRa
Andri Yadi
 
The current state of LoRaWAN security
📡 Sebastien Dudek
 
Brief LoRaWAN Overview
Alper Yegin
 
Open fest2018 LoRa, LoRa WAN, The Thing Network - capabilities, myths, applic...
Olimex Bulgaria
 
Seeeduino LoRaWAN
Michele La Malva Moreno
 
LPWAN.pdf
EzioAuditore278720
 
Analysis of Energy Consumption in MCU for IoT System
IRJET Journal
 
Intro Lora - Makers.ID Meetup
Mif Masterz
 
LoRa General Presentation FOR MASSIVE DEPLOYMENT.pptx
WidedAhmadi
 
LoRa General Presentation FOR MASSIVE DEPLOYMENT.pptx
WidedAhmadi
 
LoRaPresentation20255555555555555555555555555555555555.pdf
WidedAhmadi
 
LoRa General Presentation LoRa General Presentation.pdf
ssuser262297
 
Lorawan: What you need to know
Paul Coomans
 
Webinar: Tecnologia LoRa – Do dispositivo à nuvem
Embarcados
 
LORA BASED DATA ACQUISITION SYSTEM
IRJET Journal
 
Implementing lora smartcity doin
Jonny Doin
 
LPWAN London Meetup: Solving Urban Challenges
Digital Catapult
 
Long-Range Low-power Radio (LoRa).pptx
Ajay Gangakhedkar
 
Low power wireless technologies for connecting embedded sensors in the IoT: A...
Gilles Callebaut
 
Ad

More from Jian-Hong Pan (20)

PDF
Build a system with the filesystem maintained by OSTree @ COSCUP 2025
Jian-Hong Pan
 
PDF
D-Bus Usage and Debug Introduction @ COSCUP 2024
Jian-Hong Pan
 
PDF
國稅局，我也好想用電腦報稅
Jian-Hong Pan
 
PDF
Share the Experience of Using Embedded Development Board
Jian-Hong Pan
 
PDF
Package a PyApp as a Flatpak Package: An HTTP Server for Example @ PyCon APAC...
Jian-Hong Pan
 
PDF
Launch the First Process in Linux System
Jian-Hong Pan
 
PDF
Let's trace Linux Lernel with KGDB @ COSCUP 2021
Jian-Hong Pan
 
PDF
A Journey to Boot Linux on Raspberry Pi
Jian-Hong Pan
 
PDF
Have a Simple Modbus Server
Jian-Hong Pan
 
PDF
Software Packaging for Cross OS Distribution
Jian-Hong Pan
 
PDF
Nasa Hackthon 2018 Light Wonder - Go! Polar Bear!
Jian-Hong Pan
 
PDF
The Considerations for Internet of Things @ 2017
Jian-Hong Pan
 
PDF
Build a Micro HTTP Server for Embedded System
Jian-Hong Pan
 
PDF
Micro HTTP Server Implemented in C @ COSCUP 2016
Jian-Hong Pan
 
PDF
Bind Python and C @ COSCUP 2015
Jian-Hong Pan
 
PDF
Find the bottleneck of your system
Jian-Hong Pan
 
PDF
Learn How to Develop Embedded System for ARM @ 2014.12.22 JuluOSDev
Jian-Hong Pan
 
PDF
Debug C/C++ Programs More Comfortably @ 2014.12.14 Trace Code Meetup
Jian-Hong Pan
 
PDF
Make Your Own Developement Board @ 2014.4.21 JuluOSDev
Jian-Hong Pan
 
PDF
The Simple Scheduler in Embedded System @ OSDC.TW 2014
Jian-Hong Pan
 
Build a system with the filesystem maintained by OSTree @ COSCUP 2025
Jian-Hong Pan
 
D-Bus Usage and Debug Introduction @ COSCUP 2024
Jian-Hong Pan
 
國稅局，我也好想用電腦報稅
Jian-Hong Pan
 
Share the Experience of Using Embedded Development Board
Jian-Hong Pan
 
Package a PyApp as a Flatpak Package: An HTTP Server for Example @ PyCon APAC...
Jian-Hong Pan
 
Launch the First Process in Linux System
Jian-Hong Pan
 
Let's trace Linux Lernel with KGDB @ COSCUP 2021
Jian-Hong Pan
 
A Journey to Boot Linux on Raspberry Pi
Jian-Hong Pan
 
Have a Simple Modbus Server
Jian-Hong Pan
 
Software Packaging for Cross OS Distribution
Jian-Hong Pan
 
Nasa Hackthon 2018 Light Wonder - Go! Polar Bear!
Jian-Hong Pan
 
The Considerations for Internet of Things @ 2017
Jian-Hong Pan
 
Build a Micro HTTP Server for Embedded System
Jian-Hong Pan
 
Micro HTTP Server Implemented in C @ COSCUP 2016
Jian-Hong Pan
 
Bind Python and C @ COSCUP 2015
Jian-Hong Pan
 
Find the bottleneck of your system
Jian-Hong Pan
 
Learn How to Develop Embedded System for ARM @ 2014.12.22 JuluOSDev
Jian-Hong Pan
 
Debug C/C++ Programs More Comfortably @ 2014.12.14 Trace Code Meetup
Jian-Hong Pan
 
Make Your Own Developement Board @ 2014.4.21 JuluOSDev
Jian-Hong Pan
 
The Simple Scheduler in Embedded System @ OSDC.TW 2014
Jian-Hong Pan
 

Recently uploaded (20)

PDF
Network Security Unit 5.pdf for BCA BBA.
Serpent6
 
PPTX
20250228 LYD VKU AI Blended-Learning.pptx
DatVoNgoc
 
PDF
Agricultural_Statistics_at_a_Glance_2022_0.pdf
SandeepSingh286037
 
PDF
Profit Center Accounting in SAP S/4HANA, S4F28 Col11
Libreria ERP
 
PDF
Mobile App Security Testing_ A Comprehensive Guide.pdf
flufftailshop
 
PDF
Chapter 3 Spatial Domain Image Processing.pdf
Getnet Tigabie Askale -(GM)
 
PDF
Blue Purple Modern Animated Computer Science Presentation.pdf.pdf
Akar16
 
PDF
Spectral efficient network and resource selection model in 5G networks
IAESIJAI
 
PDF
Peak of Data & AI Encore- AI for Metadata and Smarter Workflows
Safe Software
 
PDF
Empathic Computing: Creating Shared Understanding
Mark Billinghurst
 
PDF
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
SOFTTECHHUB
 
PDF
Per capita expenditure prediction using model stacking based on satellite ima...
IAESIJAI
 
PPTX
Machine Learning_overview_presentation.pptx
kondavamsidharreddy2
 
PDF
Review of recent advances in non-invasive hemoglobin estimation
IAESIJAI
 
PDF
Unlocking AI with Model Context Protocol (MCP)
Brian McKeiver
 
PDF
MIND Revenue Release Quarter 2 2025 Press Release
MIND CTI
 
PDF
Machine learning based COVID-19 study performance prediction
IAESIJAI
 
PPTX
Programs and apps: productivity, graphics, security and other tools
4mqw9zch22
 
PDF
Reach Out and Touch Someone: Haptics and Empathic Computing
Mark Billinghurst
 
PDF
Approach and Philosophy of On baking technology
30anthuong17
 
Network Security Unit 5.pdf for BCA BBA.
Serpent6
 
20250228 LYD VKU AI Blended-Learning.pptx
DatVoNgoc
 
Agricultural_Statistics_at_a_Glance_2022_0.pdf
SandeepSingh286037
 
Profit Center Accounting in SAP S/4HANA, S4F28 Col11
Libreria ERP
 
Mobile App Security Testing_ A Comprehensive Guide.pdf
flufftailshop
 
Chapter 3 Spatial Domain Image Processing.pdf
Getnet Tigabie Askale -(GM)
 
Blue Purple Modern Animated Computer Science Presentation.pdf.pdf
Akar16
 
Spectral efficient network and resource selection model in 5G networks
IAESIJAI
 
Peak of Data & AI Encore- AI for Metadata and Smarter Workflows
Safe Software
 
Empathic Computing: Creating Shared Understanding
Mark Billinghurst
 
TokAI - TikTok AI Agent : The First AI Application That Analyzes 10,000+ Vira...
SOFTTECHHUB
 
Per capita expenditure prediction using model stacking based on satellite ima...
IAESIJAI
 
Machine Learning_overview_presentation.pptx
kondavamsidharreddy2
 
Review of recent advances in non-invasive hemoglobin estimation
IAESIJAI
 
Unlocking AI with Model Context Protocol (MCP)
Brian McKeiver
 
MIND Revenue Release Quarter 2 2025 Press Release
MIND CTI
 
Machine learning based COVID-19 study performance prediction
IAESIJAI
 
Programs and apps: productivity, graphics, security and other tools
4mqw9zch22
 
Reach Out and Touch Someone: Haptics and Empathic Computing
Mark Billinghurst
 
Approach and Philosophy of On baking technology
30anthuong17
 

Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT

  • 1. Let's Have an IEEE 802.15.4 over LoRa Linux Device Driver for IoT SX1278 Transceiver in LoRa Mode for Example Jian-Hong Pan (StarNight) @ 2017.11.28 Taiwan Linux Kernel Hackers
  • 2. Outline ● History ● OSI 7 Layers ○ LoRa / LoRaWAN ○ IEEE 802.15.4 ● Hardware ○ LoRa Transceiver ■ State Machine ■ FIFO Data Buffer ● Approaches ○ File Operations ○ IEEE 802.15.4 ● Driver Implementaion ○ Used APIs in Driver ○ The Driver Introduction ○ Device Tree & Tests ● Summary
  • 3. Who am I 潘建宏 / Jian-Hong Pan (StarNight) I come from Taiwan ! You can find me at ～ http://www.slideshare.net/chienhungpan/ GitHub : starnight Facebook : Jian-Hong Pan Email : starnight [AT] g.ncu.edu.tw
  • 4. History ● The Physics of the IoT ○ by David Mikolas @ Taipei.py 2016.06.30 ○ https://www.youtube.com/watch?v=iVlXt6RbgCE#t=18m30s ● 科技農夫陳幸延──農田裡的開源自造者 ○ The Scientific Farmer, Yan -- A Maker in the Farm ○ by 顏理謙, BUSINESS NEXT - 2016.06.10 ● Location Aware Sensor System (LASS) ○ LASS環境感測網路系統 http://lass-net.org/ ● 【科技農夫共創微氣候新農耕模式】年輕小農靠開源翻轉傳 統農業 ○ [Scientific farmers creates the new farming methods and utensils] Young farmers strengthen traditional agriculture with Open Source ○ by 何維涓, iThome - 2017.08.19
  • 5. Wireless Technology ● Features ○ Long distance (coverage) ○ Short data message ○ Power consumption issue ● Low-Rate Wireless Personal Area Networks (LR-WPANs) ○ IEEE 802.15.4 ● Low-Power Wide-Area Network (LPWAN) ○ LoRa ○ Ultra Narrow Band: ■ Sigfox, NB-IoT ... Gateway or Edge Internet End-Device End-Device End-Device Outdoor Wireless measurement / control
  • 6. From LPWAN - The Benefits of LPWAN Technology vs Other IoT Connectivity Options, written by Calum McClelland on iotforall.com Bandwidth - Range of Wireless LoRa
  • 7. OSI 7 Layers Reference: Wikipedia OSI model https://en.wikipedia.org/wiki/OSI_model Physical Data Link Network Transport Session Presentation Application HTTP Sockets HTML HTTP Web API TCP IP Link neighbors Controlled by Application Controlled by OS Electrics, Lines / Radio Socket APIs
  • 8. LoRa LoRa is the physical (PHY) layer or the wireless modulation utilized to create the long range communication link. ● Chirp spread spectrum (CSS) radio modulation ● Good link budget ● Low data rate ● Could be quite low power consumption ● Radio frequency should be used according to regional laws Reference: LoRaWAN™ 101 – A Technical Introduction by LoRa Alliance - November, 2015 What is LoRa? by LINK LABS - February 14, 2015
  • 9. Link Budget dbm TX Power RX Power TX Antenna RX Antenna Connector Connector Free Space distance
  • 10. LoRaWAN LoRaWAN is a media access control (MAC) layer protocol for managing communication between LPWAN gateways and end-node devices, maintained by the LoRa Alliance. ● Star topology ● Uplink - Downlink ● Over LoRa or FSK Reference: Wikipedia LPWAN https://en.wikipedia.org/wiki/LPWAN LoRaWAN™ Specification V1.0.2 by LoRa Alliance - July, 2016, P.12 ● Classes ○ Class A: Base line ○ Class B: Beacon ○ Class C: Continuous
  • 11. LoRa Physical Message Formats Preamble PHDR PHDR_CRC PHYPayload CRC Preamble PHDR PHDR_CRC PHYPayload Uplink Message: Downlink Message: Preamble, PHDR, PHDR_CRC and CRC are inserted by the radio transceiver Reference: LoRaWAN™ Specification V1.0.2 by LoRa Alliance - July, 2016, P.11
  • 12. IEEE 802.15.4 IEEE 802.15.4 is a technical standard which defines the operation of low-rate wireless personal area networks (LR-WPANs). It specifies the physical (PHY) layer and media access control (MAC) for LR-WPANs. Reference: Wikipedia IEEE 802.15.4 https://en.wikipedia.org/wiki/IEEE_802.15.4 Cluster tree networkStar topology Peer to peer topology PAN Coordinator Full-Function Device (FFD) Reduced-Function Device (RFD)
  • 13. Comparison LoRaWAN Star Topology LoRa Good Link Budget IEEE 802.15.4 MAC Cluster Tree Network IEEE 802.15.4 PHY Normal Link Budget Application Presentation Session Transport Network MAC Layer PHY Layer LR-WPAN LPWAN
  • 14. Combine Both Advantages Application Presentation Session Transport Network MAC Layer IEEE 802.15.4 MAC Cluster Tree Network PHY Layer LoRa Good Link Budget TCP/UDP 6LoWPAN Socket APIs LoRa acts as an IEEE 802.15.4 PHY
  • 15. Cluster Tree Network & Good Link Budget Internet PAN Coordinator Full-Function Device (FFD) Reduced-Function Device (FFD) LoRa Each node can have a IPv6 address, if it has 6LoWPAN
  • 16. LoRa Transceiver Hardware SX127X SPI Main Board Raspberry Pi SPI_CE1 SPI BUS LoRa Transceiver SX127X SPI Main Board Raspberry Pi SPI_CE1 SPI BUS
  • 18. One of LoRa Transceiver Semtech - SX1276/77/78/79 for example http://www.semtech.com/images/datasheet/sx1276.pdf ● 168 dB maximum link budget ● High sensitivity: down to -148 dBm ● LoRa and FSK/OOK mode ● SPI interface Part Number Frequency Range Spreading Factor Bandwidth Effective Bitrate Est. Sensitivity SX1276 137 - 1020 MHz 6 - 12 7.8 - 500 kHz .018 - 37.5 kbps -111 to -148 dBm SX1277 137 - 1020 MHz 6 - 9 7.8 - 500 kHz .011 - 37.5 kbps -111 to -139 dBm SX1278 137 - 525 MHz 6 - 12 7.8 - 500 kHz .018 - 37.5 kbps -111 to -148 dBm SX1279 137 - 960MHz 6 - 12 7.8 - 500 kHz .018 - 37.5 kbps -111 to -148 dBm
  • 19. State Machine of SX127X Transceiver SLEEP STANDBY TX RXSINGLE Set by command Set by command TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Only focus on used states
  • 20. SX127X Transceiver’s IRQ Flags Bit Flag 7 RxTimeout 6 RxDone 5 PayloadCrcError 4 ValidHeader 3 TxDone 2 CadDone 1 FhssChangeChannel 0 CadDetected Reference: Semtech SX1276/77/78/79 datasheet, P.111, Figure 8. LoRaTM Mode Register Map RegIrqFlags (0x12)
  • 21. SX127X Transceiver Linux Device Driver ● File Operation Interface ○ https://github.com/starnight/LoRa/tree/file-ops ○ File + SPI ○ As a character device node: /dev/loraSPIX.X ○ read/write from/to the FIFO data buffer, ioctl sets transceiver’s parameter ● IEEE 802.15.4 Interface ○ https://github.com/starnight/LoRa ○ IEEE 802.15.4 MAC + SPI ○ As a WPAN network interface ○ socket with 6LoWPAN over IEEE 802.15.4 MAC
  • 22. Used APIs in Driver ● SPI ○ The communication bus with SX127X transceiver ● regmap ○ The common wrapper of low rate buses, like SPI, I2 C ... ● IEEE 802.15.4 ○ The LR-WPAN module in kernel ● Timer & Interrupt ○ Used for polling the state of the transciver periodically ● workqueue ○ The work scheduled by timer interrupt service routine ○ The work should check and do some things according to the state of transceiver ● Spin lock ○ Lock the state flags in the driver of the transceiver ● Device Tree ○ Set parameters with the configuration in device tree, if Open Firmware is enabled
  • 23. Flow Charts of Driver Module Init & Exit module_init register SX1278 as an SPI driver End unregister SX1278 SPI driver End module_exit
  • 24. Register SX1278 as SPI Protocol Driver /* The SPI driver which acts as a protocol driver in this kernel module. */ static struct spi_driver sx1278_spi_driver = { .driver = { .name = __DRIVER_NAME, .owner = THIS_MODULE, #ifdef CONFIG_OF .of_match_table = of_match_ptr(sx1278_dt_ids), #endif #ifdef CONFIG_ACPI .acpi_match_table = ACPI_PTR(sx1278_acpi_ids), #endif }, .probe = sx1278_spi_probe, .remove = sx1278_spi_remove, .id_table = sx1278_spi_ids, }; /* Register SX1278 kernel module. */ module_spi_driver(sx1278_spi_driver); Note: spi_match_device Matched by Open Firmware Matched by ACPI Matched by SPI Bus Device Tree Macro
  • 25. of, acpi, id _match_table /* The compatible chip array. */ #ifdef CONFIG_OF static const struct of_device_id sx1278_dt_ids[] = { { .compatible = "semtech,sx1276" }, { .compatible = "semtech,sx1277" }, { .compatible = "semtech,sx1278" }, { .compatible = "semtech,sx1279" }, { .compatible = "sx1278" }, {}, }; MODULE_DEVICE_TABLE(of, sx1278_dt_ids); #endif /* The compatible ACPI device array. */ #ifdef CONFIG_ACPI static const struct acpi_device_id sx1278_acpi_ids[] = { { .id = "sx1278" }, {}, }; MODULE_DEVICE_TABLE(acpi, sx1278_acpi_ids); #endif /* The compatible SPI device id array. */ static const struct spi_device_id sx1278_spi_ids[] = { { .name = "sx1278" }, {}, }; MODULE_DEVICE_TABLE(spi, sx1278_spi_ids);
  • 26. Flow Chart of Probing an SPI Device Have a block of memory to hold the IEEE 802.15.4 compatible hardware Set the LoRa PHY as SPI deivce’s privata data End Probe an SPI device Have a regmap wrapper for the SPI bus to transceiver Set the RF channels & output power Set the IEEE 802.15.4 address Register the LoRa PHY as an IEEE 802.15.4 hardware Set the timer interrupt & the work going to be scheduled Initial the LoRa PHY sx1278_ieee_add_one
  • 27. SPI Probe Device Callback Function static int sx1278_spi_probe(struct spi_device *spi) { struct ieee802154_hw *hw; struct sx1278_phy *phy; int err; hw = ieee802154_alloc_hw(sizeof(*phy), &sx1278_ops); ... phy = hw->priv; phy->hw = hw; hw->parent = &spi->dev; phy->map = devm_regmap_init_spi(spi, &sx1278_regmap_config); /* Set the SPI device's driver data for later usage. */ spi_set_drvdata(spi, phy); err = sx1278_ieee_add_one(phy); ... } Allocate a block of memory to hold the data of IEEE 802.15.4 compatible hardware
  • 28. static const struct ieee802154_ops sx1278_ops = { .owner = THIS_MODULE, .xmit_async = sx1278_ieee_xmit, .ed = sx1278_ieee_ed, .set_channel = sx1278_ieee_set_channel, .set_txpower = sx1278_ieee_set_txpower, .start = sx1278_ieee_start, .stop = sx1278_ieee_stop, .set_promiscuous_mode = sx1278_ieee_set_promiscuous_mode, }; The entry points of IEEE 802.15.4 actions IEEE 802.15.4 Ops. of SX1278 Driver
  • 29. struct sx1278_phy phy cfg802154_registered_device Block Memory of IEEE 802.15.4 Device struct wpan_phy wpan_phy struct ieee802154_local *local = wpan_phy.priv struct wpan_phy *phy ieee802154_ops *ops struct ieee802154_hw hw struct wpan_phy *phy void *priv struct device *parent struct regmap *map struct ieee802154_hw *hw sx1278_ops regmap device of SPI pointed by IEEE 802.15.4 module ieee802154_alloc_hw pointed by SX1278 driver sx1278_spi_probe
  • 30. SPI Probe Device Callback Function static int sx1278_spi_probe(struct spi_device *spi) { struct ieee802154_hw *hw; struct sx1278_phy *phy; int err; hw = ieee802154_alloc_hw(sizeof(*phy), &sx1278_ops); ... phy = hw->priv; phy->hw = hw; hw->parent = &spi->dev; phy->map = devm_regmap_init_spi(spi, &sx1278_regmap_config); /* Set the SPI device's driver data for later usage. */ spi_set_drvdata(spi, phy); err = sx1278_ieee_add_one(phy); ... } Allocate a block of memory to hold the data of IEEE 802.15.4 compatible hardware Have a regmap wrapping the SPI bus to the transceiver Set the phy as the driver data of the SPI device
  • 31. struct sx1278_phy struct sx1278_phy { struct ieee802154_hw *hw; struct regmap *map; bool suspended; u8 opmode; struct timer_list timer; struct work_struct irqwork; /* Lock the RX and TX actions. */ spinlock_t buf_lock; struct sk_buff *tx_buf; u8 tx_delay; bool one_to_be_sent; bool post_tx_done; bool is_busy; };
  • 32. Register SX1278 as IEEE 802.15.4 PHY static int sx1278_ieee_add_one(struct sx1278_phy *phy) { struct ieee802154_hw *hw = phy->hw; int err; /* Define channels could be used. */ hw->phy->supported.channels[0] = sx1278_ieee_channel_mask(hw); /* SX1278 phy channel 11 as default */ hw->phy->current_channel = 11; /* Define RF power. */ hw->phy->supported.tx_powers = sx1278_powers; hw->phy->supported.tx_powers_size = ARRAY_SIZE(sx1278_powers); hw->phy->transmit_power = sx1278_powers[12]; ieee802154_random_extended_addr(&hw->phy->perm_extended_addr); ... Set usable RF channels of the SX127X transceiver Set usable RF output powers of the SX127X transceiver Generates a random extended address of IEEE 802.15.4 MAC
  • 33. Register SX1278 as IEEE 802.15.4 PHY Continue ... hw->flags = IEEE802154_HW_TX_OMIT_CKSUM | IEEE802154_HW_RX_OMIT_CKSUM | IEEE802154_HW_PROMISCUOUS; err = ieee802154_register_hw(hw); ... INIT_WORK(&phy->irqwork, sx1278_timer_irqwork); init_timer(&phy->timer); phy->timer.expires = jiffies_64 + HZ; phy->timer.function = sx1278_timer_isr; phy->timer.data = (unsigned long)phy; spin_lock_init(&phy->buf_lock); err = init_sx127x(phy->map); ... } Do/Not do generate frame check sum Register SX1278 as an IEEE 802.15.4 PHY Bind the function to the work which is going to be scheduled by the timer ISR Initial settings of the timer including the timer ISR The argument phy going to be passed into timer ISR
  • 34. Flow Chart of Probing an SPI Device Have the LoRa PHY from SPI device’s privata data End Remove an SPI device Delete and stop the timer Flush the work scheduled by timer ISR Unregister the IEEE 802.15.4 hardware Free the IEEE 802.15.4 hardware sx1278_ieee_delete
  • 35. SPI Remove Device Callback Function static int sx1278_spi_remove(struct spi_device *spi) { struct sx1278_phy *phy = spi_get_drvdata(spi); sx1278_ieee_del(phy); return 0; } static void sx1278_ieee_del(struct sx1278_phy *phy) { if (!phy) return; del_timer(&phy->timer); flush_work(&phy->irqwork); ieee802154_unregister_hw(phy->hw); ieee802154_free_hw(phy->hw); } Get the phy from the SPI device’s driver data Stop timing and delete the timer Wait for irqwork to finish executing the last queueing instance Unregister and free the IEEE 802.15.4 compatible device
  • 36. Polling the State of SX127X Periodically SLEEP STANDBY TX RXSINGLE Set by command Set by command TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Polling when Timer Interrupted !!!
  • 37. Polling when Timer Interrupted 1. When to start the timer? a. The IEEE 802.15.4 interface is becoming up. 2. When to stop the timer? a. The IEEE 802.15.4 interface is becoming down. 3. Timer interrupt is an interrupt, so there should not be any long time block in the interrupt service routine. a. Polling the SX127X transceiver’s state will need SPI transferring. b. SPI locks the system when it is transfering the SPI message synchronously. c. Schedule a work to workqueue in timer’s interrupt service routine!!!
  • 38. IEEE 802.15.4 Interface Up & Down static const struct ieee802154_ops sx1278_ops = { .owner = THIS_MODULE, .xmit_async = sx1278_ieee_xmit, .ed = sx1278_ieee_ed, .set_channel = sx1278_ieee_set_channel, .set_txpower = sx1278_ieee_set_txpower, .start = sx1278_ieee_start, .stop = sx1278_ieee_stop, .set_promiscuous_mode = sx1278_ieee_set_promiscuous_mode, }; ip link set <interface> up ip link set <interface> down
  • 39. IEEE 802.15.4 Interface Up static int sx1278_ieee_start(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; dev_dbg(regmap_get_device(phy->map), "interface upn"); sx1278_ieee_set_channel(hw, 0, hw->phy->current_channel); phy->suspended = false; sx127X_start_loramode(phy->map); phy->opmode = sx127X_get_mode(phy->map); add_timer(&phy->timer); return 0; } Set the RF using channel and frequency Set the SX127X transceiver in LoRa mode Get the SX127X transceiver operating mode Enable timer
  • 40. IEEE 802.15.4 Interface Down static void sx1278_ieee_stop(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; dev_dbg(regmap_get_device(phy->map), "interface downn"); phy->suspended = true; del_timer(&phy->timer); sx127X_set_state(phy->map, SX127X_SLEEP_MODE); } Disable timer Make the SX127X transceiver go to sleep
  • 41. Schedule a work into workqueue in ISR static void sx1278_timer_isr(unsigned long arg) { struct sx1278_phy *phy = (struct sx1278_phy *)arg; schedule_work(&phy->irqwork); } Push the work into workqueue static void sx1278_timer_irqwork(struct work_struct *work) { struct sx1278_phy *phy; phy = container_of(work, struct sx1278_phy, irqwork); sx1278_ieee_statemachine(phy->hw); } Get container structure of work Do polling the SX127X’s state When the work is scheduled to be executing
  • 42. Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command: sx1278_ieee_xmit register one new frame going to be sent TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY
  • 43. Do Polling SX127X Transceiver’s State void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; u8 flags; u8 state; bool do_next_rx = false; flags = sx127X_get_loraallflag(phy->map); state = sx127X_get_state(phy->map); Should be one or composed of: ● SX127X_FLAG_RXTIMEOUT ● SX127X_FLAG_PAYLOADCRCERROR ● SX127X_FLAG_RXDONE ● SX127X_FLAG_TXDONE Should be one of: ● SX127X_SLEEP_MODE ● SX127X_STANDBY_MODE ● SX127X_TX_MODE ● SX127X_RXSINGLE_MODE
  • 44. if (flags & (SX127X_FLAG_RXTIMEOUT | SX127X_FLAG_PAYLOADCRCERROR)) { sx127X_clear_loraflag(phy->map, SX127X_FLAG_RXTIMEOUT | SX127X_FLAG_PAYLOADCRCERROR | SX127X_FLAG_RXDONE); spin_lock(&phy->buf_lock); phy->is_busy = false; spin_unlock(&phy->buf_lock); do_next_rx = true; } else if (flags & SX127X_FLAG_RXDONE) { sx1278_ieee_rx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_RXDONE); do_next_rx = true; } Check the SX127X transceiver is receiving time out or CRC error Check the SX127X transceiver is already received a new frame
  • 45. if (flags & SX127X_FLAG_TXDONE) { sx1278_ieee_tx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_TXDONE); phy->tx_delay = 10; do_next_rx = true; } if (phy->one_to_be_sent && (state == SX127X_STANDBY_MODE) && (phy->tx_delay == 0)) { if (!sx1278_ieee_tx(phy->hw)) do_next_rx = false; } Check the SX127X transceiver is already transmit a frame out Check the SX127X transceiver 1. Have a new frame going to be transmit 2. Can try to transmit the new frame a. Is not busy → standby b. Transmit delay is enough
  • 46. if (do_next_rx) sx1278_ieee_rx(phy->hw); if (phy->tx_delay > 0) phy->tx_delay -= 1; if (!phy->suspended) { phy->timer.expires = jiffies_64 + 1; add_timer(&phy->timer); } } Ask transceiver try to do receiving again, if it is not busy Enable the timer again, if the interface is still enabled Wait for polling SX127X transceiver’s state next time Decrease the counter of transmission delay
  • 47. Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command in sx1278_ieee_statemachine TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY sx1278_ieee_xmit register a new frame going to be sent
  • 48. IEEE 802.15.4 Xmit static const struct ieee802154_ops sx1278_ops = { .owner = THIS_MODULE, .xmit_async = sx1278_ieee_xmit, .ed = sx1278_ieee_ed, .set_channel = sx1278_ieee_set_channel, .set_txpower = sx1278_ieee_set_txpower, .start = sx1278_ieee_start, .stop = sx1278_ieee_stop, .set_promiscuous_mode = sx1278_ieee_set_promiscuous_mode, }; ieee802154_tx in IEEE 802.15.4 module
  • 49. Register a New Frame going to be Sent static int sx1278_ieee_xmit(struct ieee802154_hw *hw, struct sk_buff *skb) { struct sx1278_phy *phy = hw->priv; int ret; ... spin_lock(&phy->buf_lock); if (phy->tx_buf) { ret = -EBUSY; } else { phy->tx_buf = skb; phy->one_to_be_sent = true; phy->post_tx_done = false; ret = 0; } spin_unlock(&phy->buf_lock); return ret; } Check no pending frame going to be sent Register the new frame going to be sent
  • 50. void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { ... if (flags & SX127X_FLAG_TXDONE) { sx1278_ieee_tx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_TXDONE); phy->tx_delay = 10; do_next_rx = true; } if (phy->one_to_be_sent && (state == SX127X_STANDBY_MODE) && (phy->tx_delay == 0)) { if (!sx1278_ieee_tx(phy->hw)) do_next_rx = false; } ... } Do Xmit a Frame during Polling State
  • 51. Do Xmit a Frame int sx1278_ieee_tx(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; struct sk_buff *tx_buf = phy->tx_buf; bool do_tx = false; … if (!phy->post_tx_done) { sx127X_sendloradata(phy->map, tx_buf->data, tx_buf->len); phy->post_tx_done = true; } Prepare and write the new frame’s data to SX127X transceiver’s TX FIFO
  • 52. Xmit a Frame after Fill SX127X TX FIFO spin_lock(&phy->buf_lock); if (!phy->is_busy) { phy->is_busy = true; do_tx = true; phy->one_to_be_sent = false; } spin_unlock(&phy->buf_lock); if (do_tx) { /* Set chip as TX state and transfer the data in FIFO. */ phy->opmode = (phy->opmode & 0xF8) | SX127X_TX_MODE; regmap_write_async(phy->map, SX127X_REG_OP_MODE, phy->opmode); return 0; } else { … return -EBUSY; } } Change the SX127X transceiver to TX state and start TX action
  • 53. TX FIFO of SX127X Transceiver PayloadLength Reference: Semtech SX1276/77/78/79 datasheet, P.34, Figure 8. LoRaTM Data Buffer FifoTxBaseAddr SPI Read/WriteFifoAddrPtr 256 bytes FIFO
  • 54. Filling SX127X Transceiver’s TX FIFO size_t sx127X_sendloradata(struct regmap *map, u8 *buf, size_t len) { u8 base_adr; u8 blen; /* Set chip FIFO pointer to FIFO TX base. */ base_adr = SX127X_FIFO_TX_BASE_ADDRESS; regmap_raw_write(map, SX127X_REG_FIFO_ADDR_PTR, &base_adr, 1); /* Write payload synchronously to fill the FIFO of the chip. */ blen = (len <= IEEE802154_MTU) ? len : IEEE802154_MTU; regmap_raw_write(map, SX127X_REG_FIFO, buf, blen); /* Set the FIFO payload length. */ regmap_raw_write(map, SX127X_REG_PAYLOAD_LENGTH, &blen, 1); return blen; } Set FIFO address going to write start with Fill TX payload in to FIFO Set TX payload length
  • 55. void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { ... if (flags & SX127X_FLAG_TXDONE) { sx1278_ieee_tx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_TXDONE); phy->tx_delay = 10; do_next_rx = true; } if (phy->one_to_be_sent && (state == SX127X_STANDBY_MODE) && (phy->tx_delay == 0)) { if (!sx1278_ieee_tx(phy->hw)) do_next_rx = false; } ... } Xmit Finished during Polling State
  • 56. Response Xmit a Frame is Finished static int sx1278_ieee_tx_complete(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; struct sk_buff *skb = phy->tx_buf; dev_dbg(regmap_get_device(phy->map), "%sn", __func__); ieee802154_xmit_complete(hw, skb, false); spin_lock(&phy->buf_lock); phy->is_busy = false; phy->tx_buf = NULL; spin_unlock(&phy->buf_lock); return 0; } Response to IEEE 802.15.4 module that the new frame is already sent
  • 58. Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command: sx1278_ieee_xmit register one new frame going to be sent TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY
  • 59. void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { … if (do_next_rx) sx1278_ieee_rx(phy->hw); ... } Try to Receive during Polling State
  • 60. Change SX127X to RX Mode int sx1278_ieee_rx(struct ieee802154_hw *hw) { … spin_lock(&phy->buf_lock); if (!phy->is_busy) { phy->is_busy = true; do_rx = true; } else { do_rx = false; } spin_unlock(&phy->buf_lock); if (do_rx) { sx127X_set_state(phy->map, SX127X_RXSINGLE_MODE); return 0; } else { … return -EBUSY; } } Change the SX127X transceiver to RX state and try to receive only one frame
  • 61. Do Receive during Polling State void sx1278_ieee_statemachine(struct ieee802154_hw *hw) { … if (flags & (SX127X_FLAG_RXTIMEOUT | SX127X_FLAG_PAYLOADCRCERROR)) { ... } else if (flags & SX127X_FLAG_RXDONE) { sx1278_ieee_rx_complete(phy->hw); sx127X_clear_loraflag(phy->map, SX127X_FLAG_RXDONE); do_next_rx = true; } ... }
  • 62. RX FIFO of SX127X Transceiver LoRa Modem RegFifoRxCurrentAddr FifoRxBytesNb PayloadLength FifoRxBaseAddr Reference: Semtech SX1276/77/78/79 datasheet, P.34, Figure 8. LoRaTM Data Buffer FifoTxBaseAddr SPI Read/Write FifoAddrPtr 256 bytes FIFO
  • 63. Do Receive a New Incoming Frame static int sx1278_ieee_rx_complete(struct ieee802154_hw *hw) { struct sx1278_phy *phy = hw->priv; struct sk_buff *skb; … s32 rssi; s32 range = SX1278_IEEE_ENERGY_RANGE; … skb = dev_alloc_skb(IEEE802154_MTU); … len = sx127X_get_loralastpktpayloadlen(phy->map); sx127X_readloradata(phy->map, skb_put(skb, len), len); /* LQI: IEEE 802.15.4-2011 8.2.6 Link quality indicator. */ rssi = sx127X_get_loralastpktrssi(phy->map); rssi = (rssi > 0) ? 0 : rssi; lqi = ((s32)255 * (rssi + range) / range) % 255; ieee802154_rx_irqsafe(hw, skb, lqi); ... } Allocate a sk_buff to hold a new coming frame Get last packet’s payload length Read last RX packet as the new coming frame Calculate the link quality indicator Tell IEEE 802.15.4 module that there is a new incoming frame
  • 64. Reading SX127X Transceiver’s RX FIFO ssize_t sx127X_readloradata(struct regmap *map, u8 *buf, size_t len) { u8 start_adr; int ret; /* Set chip FIFO pointer to FIFO last packet address. */ start_adr = SX127X_FIFO_RX_BASE_ADDRESS; regmap_raw_write(map, SX127X_REG_FIFO_ADDR_PTR, &start_adr, 1); /* Read LoRa packet payload. */ len = (len <= IEEE802154_MTU) ? len : IEEE802154_MTU; ret = regmap_raw_read(map, SX127X_REG_FIFO, buf, len); return (ret >= 0) ? len : ret; } Set FIFO address going to read start with Read a received payload from RX FIFO
  • 65. Do Polling SX127X Transceiver’s State SLEEP TX RXSINGLE Set by command Set by command: sx1278_ieee_xmit register one new frame going to be sent TX is completed / Set by command RX is completed / RX timeout / RX CRC error / Set by command Set by command: sx1278_ieee_rx tries to receive a new frame STANDBY
  • 66. Load SX1278 as an SPI protocol driver with Device Tree configuration
  • 67. Device Tree Overlay Example sx1278@0 { compatible = "semtech,sx1278"; spi-max-frequency = <15200>; reg = <0>; clock-frequency = <32000000>; center-carrier-frq = <434000000>; minimal-RF-channel = /bits/ 8 <11>; maximum-RF-channel = /bits/ 8 <11>; };
  • 68. SX1278 Device Tree Properties ● Required properties: ○ compatible: should be "semtech,sx1276", "semtech,sx1277", "semtech,sx1278" or "semtech,sx1279" depends on your transceiver board ○ spi-max-frequency: maximal bus speed, should be set something under or equal 10000000 Hz ○ reg: the chipselect index ○ clock-frequency: the external crystal oscillator frequency in Hz of the transceiver ○ center-carrier-frq: the RF center carrier frequency in Hz ● Optional properties: ○ rf-bandwidth: the RF bandwidth in Hz ○ minimal-RF-channel: the minimal RF channel number ○ maximum-RF-channel: the maximum RF channel number ○ spreading-factor: the spreading factor of Chirp Spread Spectrum modulation
  • 69. Have test applications over 6LoWPAN over SX1278
  • 70. Client - Server Test Application These applications communicate through UDP/IPv6 socket in simple client-server model. Client Server Client send a data string to server Server send the capitalized data string to client Capitalized data string
  • 71. 6LoWPAN module & SX1278 driver Application ClientPresentation Session Transport UDP Network IPv6 MAC Layer IEEE 802.15.4 MAC PHY Layer LoRa Server UDP IPv6 IEEE 802.15.4 MAC LoRa SX1278 driver 6LoWPAN module socket
  • 72. Have lowpan interface from wpan # Private Area Network ID panid="0xbeef" # Index of the wpan interface i=0 # Set the PANID of the wpan interface iwpan dev wpan${i} set pan_id $panid # Create a lowpan interface over the wpan interface ip link add link wpan${i} name lowpan${i} type lowpan # Bring up the wpan and lowpan interfaces ip link set wpan${i} up ip link set lowpan${i} up linux-wpan/wpan-tools: Userspace tools for Linux IEEE 802.15.4 stack iwpan: based on the wireless iw tool.
  • 74. ● Server ○ server <listening IPv6 address> <listening port> ● Client ○ client <src IPv6 address> <dst IPv6 address> <dst port> <data string>
  • 77. Summary ● LoRa is a Low Power Wide Area Network(LPWAN) communitcation technology. ● Here is an IEEE 802.15.4 MAC over LoRa PHY Linux device driver. ● Pros ○ 6LoWPAN support for IEEE 802.15.4 → IPv6 for each node ○ Extending the coverage area by cluster tree network with the LoRa long communication distance of each edge is possible ● Cons ○ Extremely low data rate ○ As an external kernel module, because it is not LoRaWAN over LoRa
  • 78. Reference ● LoRaWAN™ What is it? ● LoRaWAN™ Specification V1.0.2 from LoRa™ Alliance ● Wikipedia - LPWAN ● IEEE Std 802.15.4-2015 from IEEE ● Wikipedia - IEEE 802.15.4 ● Semtech SX1276/77/78/79 datasheet ● Linux IEEE 802.15.4 Documentation ● Loopback IEEE 802.15.4 interface: fakelb.c