lriot 2.1.0.0
lr1110_bootloader_types.h File Reference

Bootloader driver types for LR1110. More...

#include <stdbool.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  lr1110_bootloader_stat1_s
 Status register 1 structure definition. More...
 
struct  lr1110_bootloader_stat2_s
 Status register 2 structure definition. More...
 
struct  lr1110_bootloader_version_s
 Bootloader version structure definition. More...
 

Macros

#define LR1110_BL_VERSION_LENGTH   ( 4 )
 Length in byte of the LR1110 version blob.
 
#define LR1110_BL_PIN_LENGTH   ( 4 )
 Length in bytes of a PIN.
 
#define LR1110_BL_CHIP_EUI_LENGTH   ( 8 )
 Length in bytes of a chip EUI.
 
#define LR1110_BL_JOIN_EUI_LENGTH   ( 8 )
 Length in bytes of a join EUI.
 

Typedefs

typedef uint8_t lr1110_bootloader_pin_t[LR1110_BL_PIN_LENGTH]
 Fixed-length array to store a PIN.
 
typedef uint8_t lr1110_bootloader_chip_eui_t[LR1110_BL_CHIP_EUI_LENGTH]
 Fixed-length array to store a chipEUI.
 
typedef uint8_t lr1110_bootloader_join_eui_t[LR1110_BL_JOIN_EUI_LENGTH]
 Fixed-length array to store a joinEUI.
 
typedef enum lr1110_bootloader_chip_modes_e lr1110_bootloader_chip_modes_t
 Chip modes.
 
typedef enum lr1110_bootloader_reset_status_e lr1110_bootloader_reset_status_t
 Reset status.
 
typedef enum lr1110_bootloader_command_status_e lr1110_bootloader_command_status_t
 Command status.
 
typedef struct lr1110_bootloader_stat1_s lr1110_bootloader_stat1_t
 Status register 1 structure definition.
 
typedef struct lr1110_bootloader_stat2_s lr1110_bootloader_stat2_t
 Status register 2 structure definition.
 
typedef struct lr1110_bootloader_version_s lr1110_bootloader_version_t
 Bootloader version structure definition.
 

Enumerations

enum  lr1110_bootloader_chip_modes_e {
  LR1110_BOOTLOADER_CHIP_MODE_SLEEP = 0x00 , LR1110_BOOTLOADER_CHIP_MODE_STBY_RC = 0x01 , LR1110_BOOTLOADER_CHIP_MODE_STBY_XOSC = 0x02 , LR1110_BOOTLOADER_CHIP_MODE_FS = 0x03 ,
  LR1110_BOOTLOADER_CHIP_MODE_RX = 0x04 , LR1110_BOOTLOADER_CHIP_MODE_TX = 0x05 , LR1110_BOOTLOADER_CHIP_MODE_LOC = 0x06
}
 Chip modes. More...
 
enum  lr1110_bootloader_reset_status_e {
  LR1110_BOOTLOADER_RESET_STATUS_CLEARED = 0x00 , LR1110_BOOTLOADER_RESET_STATUS_ANALOG = 0x01 , LR1110_BOOTLOADER_RESET_STATUS_EXTERNAL = 0x02 , LR1110_BOOTLOADER_RESET_STATUS_SYSTEM = 0x03 ,
  LR1110_BOOTLOADER_RESET_STATUS_WATCHDOG = 0x04 , LR1110_BOOTLOADER_RESET_STATUS_IOCD_RESTART = 0x05 , LR1110_BOOTLOADER_RESET_STATUS_RTC_RESTART = 0x06
}
 Reset status. More...
 
enum  lr1110_bootloader_command_status_e { LR1110_BOOTLOADER_CMD_STATUS_FAIL = 0x00 , LR1110_BOOTLOADER_CMD_STATUS_PERR = 0x01 , LR1110_BOOTLOADER_CMD_STATUS_OK = 0x02 , LR1110_BOOTLOADER_CMD_STATUS_DATA = 0x03 }
 Command status. More...
 

Detailed Description

Bootloader driver types for LR1110.

The Clear BSD License Copyright Semtech Corporation 2021. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the Semtech corporation nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SEMTECH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

◆ LR1110_BL_CHIP_EUI_LENGTH

#define LR1110_BL_CHIP_EUI_LENGTH   ( 8 )

Length in bytes of a chip EUI.

◆ LR1110_BL_JOIN_EUI_LENGTH

#define LR1110_BL_JOIN_EUI_LENGTH   ( 8 )

Length in bytes of a join EUI.

◆ LR1110_BL_PIN_LENGTH

#define LR1110_BL_PIN_LENGTH   ( 4 )

Length in bytes of a PIN.

◆ LR1110_BL_VERSION_LENGTH

#define LR1110_BL_VERSION_LENGTH   ( 4 )

Length in byte of the LR1110 version blob.

Typedef Documentation

◆ lr1110_bootloader_chip_eui_t

typedef uint8_t lr1110_bootloader_chip_eui_t[LR1110_BL_CHIP_EUI_LENGTH]

Fixed-length array to store a chipEUI.

◆ lr1110_bootloader_chip_modes_t

◆ lr1110_bootloader_command_status_t

◆ lr1110_bootloader_join_eui_t

typedef uint8_t lr1110_bootloader_join_eui_t[LR1110_BL_JOIN_EUI_LENGTH]

Fixed-length array to store a joinEUI.

◆ lr1110_bootloader_pin_t

typedef uint8_t lr1110_bootloader_pin_t[LR1110_BL_PIN_LENGTH]

Fixed-length array to store a PIN.

◆ lr1110_bootloader_reset_status_t

◆ lr1110_bootloader_stat1_t

Status register 1 structure definition.

◆ lr1110_bootloader_stat2_t

Status register 2 structure definition.

◆ lr1110_bootloader_version_t

Bootloader version structure definition.

Enumeration Type Documentation

◆ lr1110_bootloader_chip_modes_e

Chip modes.

Enumerator
LR1110_BOOTLOADER_CHIP_MODE_SLEEP 
LR1110_BOOTLOADER_CHIP_MODE_STBY_RC 
LR1110_BOOTLOADER_CHIP_MODE_STBY_XOSC 
LR1110_BOOTLOADER_CHIP_MODE_FS 
LR1110_BOOTLOADER_CHIP_MODE_RX 
LR1110_BOOTLOADER_CHIP_MODE_TX 
LR1110_BOOTLOADER_CHIP_MODE_LOC 

◆ lr1110_bootloader_command_status_e

Command status.

Enumerator
LR1110_BOOTLOADER_CMD_STATUS_FAIL 
LR1110_BOOTLOADER_CMD_STATUS_PERR 
LR1110_BOOTLOADER_CMD_STATUS_OK 
LR1110_BOOTLOADER_CMD_STATUS_DATA 

◆ lr1110_bootloader_reset_status_e

Reset status.

Enumerator
LR1110_BOOTLOADER_RESET_STATUS_CLEARED 
LR1110_BOOTLOADER_RESET_STATUS_ANALOG 
LR1110_BOOTLOADER_RESET_STATUS_EXTERNAL 
LR1110_BOOTLOADER_RESET_STATUS_SYSTEM 
LR1110_BOOTLOADER_RESET_STATUS_WATCHDOG 
LR1110_BOOTLOADER_RESET_STATUS_IOCD_RESTART 
LR1110_BOOTLOADER_RESET_STATUS_RTC_RESTART