Loading...
Searching...
No Matches
board.h File Reference

Board specific definitions for the SODAQ SARA SFF board. More...

Detailed Description

Board specific definitions for the SODAQ SARA SFF board.

Author
Kees Bakker kees@.nosp@m.soda.nosp@m.q.com

Definition in file board.h.

#include "cpu.h"
#include "board_common.h"
+ Include dependency graph for board.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

LED pin definitions and handlers

#define LED0_PIN   GPIO_PIN(PA, 16)
 
#define LED0_PORT   PORT->Group[PA]
 
#define LED0_MASK   (1 << 16)
 
#define LED0_OFF   (LED0_PORT.OUTSET.reg = LED0_MASK)
 
#define LED0_ON   (LED0_PORT.OUTCLR.reg = LED0_MASK)
 
#define LED0_TOGGLE   (LED0_PORT.OUTTGL.reg = LED0_MASK)
 
#define LED_GREEN_PIN   LED0_PIN
 
#define LED_GREEN_OFF   LED0_OFF
 
#define LED_GREEN_ON   LED0_ON
 
#define LED_GREEN_TOGGLE   LED0_TOGGLE
 
#define LED1_PIN   GPIO_PIN(PA, 14)
 
#define LED1_PORT   PORT->Group[PA]
 
#define LED1_MASK   (1 << 14)
 
#define LED1_OFF   (LED1_PORT.OUTSET.reg = LED1_MASK)
 
#define LED1_ON   (LED1_PORT.OUTCLR.reg = LED1_MASK)
 
#define LED1_TOGGLE   (LED1_PORT.OUTTGL.reg = LED1_MASK)
 
#define LED_RED_PIN   LED1_PIN
 
#define LED_RED_OFF   LED1_OFF
 
#define LED_RED_ON   LED1_ON
 
#define LED_RED_TOGGLE   LED1_TOGGLE
 
#define LED2_PIN   GPIO_PIN(PA, 15)
 
#define LED2_PORT   PORT->Group[PA]
 
#define LED2_MASK   (1 << 15)
 
#define LED2_OFF   (LED2_PORT.OUTSET.reg = LED2_MASK)
 
#define LED2_ON   (LED2_PORT.OUTCLR.reg = LED2_MASK)
 
#define LED2_TOGGLE   (LED2_PORT.OUTTGL.reg = LED2_MASK)
 
#define LED_BLUE_PIN   LED2_PIN
 
#define LED_BLUE_OFF   LED2_OFF
 
#define LED_BLUE_ON   LED2_ON
 
#define LED_BLUE_TOGGLE   LED2_TOGGLE
 

User button

#define BTN0_PIN   GPIO_PIN(PB, 8)
 
#define BTN0_MODE   GPIO_IN
 

GPS Time Pulse

#define GPS_TIMEPULSE_PIN   GPIO_PIN(PA, 17)
 
#define GPS_TIMEPULSE_MODE   GPIO_IN
 

GPS Enable

#define GPS_ENABLE_PIN   GPIO_PIN(PA, 18)
 
#define GPS_ENABLE_PORT   PORT->Group[PA]
 
#define GPS_ENABLE_MASK   (1 << 18)
 
#define GPS_ENABLE_ON   (GPS_ENABLE_PORT.OUTSET.reg = GPS_ENABLE_MASK)
 
#define GPS_ENABLE_OFF   (GPS_ENABLE_PORT.OUTCLR.reg = GPS_ENABLE_MASK)
 

SARA (UBlox) Enable

With this pin the power supply can be switched on or off.

#define SARA_ENABLE_PIN   GPIO_PIN(PA, 4)
 
#define SARA_ENABLE_PORT   PORT->Group[PA]
 
#define SARA_ENABLE_MASK   (1 << 4)
 
#define SARA_ENABLE_ON   (SARA_ENABLE_PORT.OUTSET.reg = SARA_ENABLE_MASK)
 
#define SARA_ENABLE_OFF   (SARA_ENABLE_PORT.OUTCLR.reg = SARA_ENABLE_MASK)
 

SARA (UBlox) TX Enable

With this pin level shifters can be switched on or off.

#define SARA_TX_ENABLE_PIN   GPIO_PIN(PA, 27)
 
#define SARA_TX_ENABLE_PORT   PORT->Group[PA]
 
#define SARA_TX_ENABLE_MASK   (1 << 27)
 
#define SARA_TX_ENABLE_ON   (SARA_TX_ENABLE_PORT.OUTSET.reg = SARA_TX_ENABLE_MASK)
 
#define SARA_TX_ENABLE_OFF   (SARA_TX_ENABLE_PORT.OUTCLR.reg = SARA_TX_ENABLE_MASK)
 

SARA_R4XX PWR_ON

This is the PWR_ON pin of the UBlox.

It can be used to switch the unit on or off by lowering this pin (at least for 0.15 seconds). This is needed to switch on from power-off mode and from PSM deep sleep.

#define SARA_R4XX_PWR_ON_PIN   GPIO_PIN(PB, 10)
 
#define SARA_R4XX_PWR_ON_PORT   PORT->Group[PB]
 
#define SARA_R4XX_PWR_ON_MASK   (1 << 10)
 
#define SARA_R4XX_PWR_ON_ON   (SARA_R4XX_PWR_ON_PORT.OUTSET.reg = SARA_R4XX_PWR_ON_MASK)
 
#define SARA_R4XX_PWR_ON_OFF   (SARA_R4XX_PWR_ON_PORT.OUTCLR.reg = SARA_R4XX_PWR_ON_MASK)
 

INT_MAG

The INT_MAG pin of the accelerometer (LSM303AGRTR)

#define INT_MAG_PIN   GPIO_PIN(PA, 19)
 
#define INT_MAG_MODE   GPIO_IN
 

INT1_XL

The INT1_XL pin of the accelerometer (LSM303AGRTR)

#define INT1_XL_PIN   GPIO_PIN(PA, 20)
 
#define INT1_XL_MODE   GPIO_IN
 

INT2_XL

The INT2_XL pin of the accelerometer (LSM303AGRTR)

#define INT2_XL_PIN   GPIO_PIN(PA, 21)
 
#define INT2_XL_MODE   GPIO_IN
 

Macro Definition Documentation

◆ BTN0_MODE

#define BTN0_MODE   GPIO_IN

Definition at line 78 of file board.h.

◆ BTN0_PIN

#define BTN0_PIN   GPIO_PIN(PB, 8)

Definition at line 77 of file board.h.

◆ GPS_ENABLE_MASK

#define GPS_ENABLE_MASK   (1 << 18)

Definition at line 96 of file board.h.

◆ GPS_ENABLE_OFF

#define GPS_ENABLE_OFF   (GPS_ENABLE_PORT.OUTCLR.reg = GPS_ENABLE_MASK)

Definition at line 99 of file board.h.

◆ GPS_ENABLE_ON

#define GPS_ENABLE_ON   (GPS_ENABLE_PORT.OUTSET.reg = GPS_ENABLE_MASK)

Definition at line 98 of file board.h.

◆ GPS_ENABLE_PIN

#define GPS_ENABLE_PIN   GPIO_PIN(PA, 18)

Definition at line 93 of file board.h.

◆ GPS_ENABLE_PORT

#define GPS_ENABLE_PORT   PORT->Group[PA]

Definition at line 95 of file board.h.

◆ GPS_TIMEPULSE_MODE

#define GPS_TIMEPULSE_MODE   GPIO_IN

Definition at line 86 of file board.h.

◆ GPS_TIMEPULSE_PIN

#define GPS_TIMEPULSE_PIN   GPIO_PIN(PA, 17)

Definition at line 85 of file board.h.

◆ INT1_XL_MODE

#define INT1_XL_MODE   GPIO_IN

Definition at line 166 of file board.h.

◆ INT1_XL_PIN

#define INT1_XL_PIN   GPIO_PIN(PA, 20)

Definition at line 165 of file board.h.

◆ INT2_XL_MODE

#define INT2_XL_MODE   GPIO_IN

Definition at line 176 of file board.h.

◆ INT2_XL_PIN

#define INT2_XL_PIN   GPIO_PIN(PA, 21)

Definition at line 175 of file board.h.

◆ INT_MAG_MODE

#define INT_MAG_MODE   GPIO_IN

Definition at line 156 of file board.h.

◆ INT_MAG_PIN

#define INT_MAG_PIN   GPIO_PIN(PA, 19)

Definition at line 155 of file board.h.

◆ LED0_MASK

#define LED0_MASK   (1 << 16)

Definition at line 35 of file board.h.

◆ LED0_OFF

#define LED0_OFF   (LED0_PORT.OUTSET.reg = LED0_MASK)

Definition at line 37 of file board.h.

◆ LED0_ON

#define LED0_ON   (LED0_PORT.OUTCLR.reg = LED0_MASK)

Definition at line 38 of file board.h.

◆ LED0_PIN

#define LED0_PIN   GPIO_PIN(PA, 16)

Definition at line 33 of file board.h.

◆ LED0_PORT

#define LED0_PORT   PORT->Group[PA]

Definition at line 34 of file board.h.

◆ LED0_TOGGLE

#define LED0_TOGGLE   (LED0_PORT.OUTTGL.reg = LED0_MASK)

Definition at line 39 of file board.h.

◆ LED1_MASK

#define LED1_MASK   (1 << 14)

Definition at line 48 of file board.h.

◆ LED1_OFF

#define LED1_OFF   (LED1_PORT.OUTSET.reg = LED1_MASK)

Definition at line 50 of file board.h.

◆ LED1_ON

#define LED1_ON   (LED1_PORT.OUTCLR.reg = LED1_MASK)

Definition at line 51 of file board.h.

◆ LED1_PIN

#define LED1_PIN   GPIO_PIN(PA, 14)

Definition at line 46 of file board.h.

◆ LED1_PORT

#define LED1_PORT   PORT->Group[PA]

Definition at line 47 of file board.h.

◆ LED1_TOGGLE

#define LED1_TOGGLE   (LED1_PORT.OUTTGL.reg = LED1_MASK)

Definition at line 52 of file board.h.

◆ LED2_MASK

#define LED2_MASK   (1 << 15)

Definition at line 61 of file board.h.

◆ LED2_OFF

#define LED2_OFF   (LED2_PORT.OUTSET.reg = LED2_MASK)

Definition at line 63 of file board.h.

◆ LED2_ON

#define LED2_ON   (LED2_PORT.OUTCLR.reg = LED2_MASK)

Definition at line 64 of file board.h.

◆ LED2_PIN

#define LED2_PIN   GPIO_PIN(PA, 15)

Definition at line 59 of file board.h.

◆ LED2_PORT

#define LED2_PORT   PORT->Group[PA]

Definition at line 60 of file board.h.

◆ LED2_TOGGLE

#define LED2_TOGGLE   (LED2_PORT.OUTTGL.reg = LED2_MASK)

Definition at line 65 of file board.h.

◆ LED_BLUE_OFF

#define LED_BLUE_OFF   LED2_OFF

Definition at line 68 of file board.h.

◆ LED_BLUE_ON

#define LED_BLUE_ON   LED2_ON

Definition at line 69 of file board.h.

◆ LED_BLUE_PIN

#define LED_BLUE_PIN   LED2_PIN

Definition at line 67 of file board.h.

◆ LED_BLUE_TOGGLE

#define LED_BLUE_TOGGLE   LED2_TOGGLE

Definition at line 70 of file board.h.

◆ LED_GREEN_OFF

#define LED_GREEN_OFF   LED0_OFF

Definition at line 42 of file board.h.

◆ LED_GREEN_ON

#define LED_GREEN_ON   LED0_ON

Definition at line 43 of file board.h.

◆ LED_GREEN_PIN

#define LED_GREEN_PIN   LED0_PIN

Definition at line 41 of file board.h.

◆ LED_GREEN_TOGGLE

#define LED_GREEN_TOGGLE   LED0_TOGGLE

Definition at line 44 of file board.h.

◆ LED_RED_OFF

#define LED_RED_OFF   LED1_OFF

Definition at line 55 of file board.h.

◆ LED_RED_ON

#define LED_RED_ON   LED1_ON

Definition at line 56 of file board.h.

◆ LED_RED_PIN

#define LED_RED_PIN   LED1_PIN

Definition at line 54 of file board.h.

◆ LED_RED_TOGGLE

#define LED_RED_TOGGLE   LED1_TOGGLE

Definition at line 57 of file board.h.

◆ SARA_ENABLE_MASK

#define SARA_ENABLE_MASK   (1 << 4)

Definition at line 111 of file board.h.

◆ SARA_ENABLE_OFF

#define SARA_ENABLE_OFF   (SARA_ENABLE_PORT.OUTCLR.reg = SARA_ENABLE_MASK)

Definition at line 114 of file board.h.

◆ SARA_ENABLE_ON

#define SARA_ENABLE_ON   (SARA_ENABLE_PORT.OUTSET.reg = SARA_ENABLE_MASK)

Definition at line 113 of file board.h.

◆ SARA_ENABLE_PIN

#define SARA_ENABLE_PIN   GPIO_PIN(PA, 4)

Definition at line 108 of file board.h.

◆ SARA_ENABLE_PORT

#define SARA_ENABLE_PORT   PORT->Group[PA]

Definition at line 110 of file board.h.

◆ SARA_R4XX_PWR_ON_MASK

#define SARA_R4XX_PWR_ON_MASK   (1 << 10)

Definition at line 143 of file board.h.

◆ SARA_R4XX_PWR_ON_OFF

#define SARA_R4XX_PWR_ON_OFF   (SARA_R4XX_PWR_ON_PORT.OUTCLR.reg = SARA_R4XX_PWR_ON_MASK)

Definition at line 146 of file board.h.

◆ SARA_R4XX_PWR_ON_ON

#define SARA_R4XX_PWR_ON_ON   (SARA_R4XX_PWR_ON_PORT.OUTSET.reg = SARA_R4XX_PWR_ON_MASK)

Definition at line 145 of file board.h.

◆ SARA_R4XX_PWR_ON_PIN

#define SARA_R4XX_PWR_ON_PIN   GPIO_PIN(PB, 10)

Definition at line 140 of file board.h.

◆ SARA_R4XX_PWR_ON_PORT

#define SARA_R4XX_PWR_ON_PORT   PORT->Group[PB]

Definition at line 142 of file board.h.

◆ SARA_TX_ENABLE_MASK

#define SARA_TX_ENABLE_MASK   (1 << 27)

Definition at line 126 of file board.h.

◆ SARA_TX_ENABLE_OFF

#define SARA_TX_ENABLE_OFF   (SARA_TX_ENABLE_PORT.OUTCLR.reg = SARA_TX_ENABLE_MASK)

Definition at line 129 of file board.h.

◆ SARA_TX_ENABLE_ON

#define SARA_TX_ENABLE_ON   (SARA_TX_ENABLE_PORT.OUTSET.reg = SARA_TX_ENABLE_MASK)

Definition at line 128 of file board.h.

◆ SARA_TX_ENABLE_PIN

#define SARA_TX_ENABLE_PIN   GPIO_PIN(PA, 27)

Definition at line 123 of file board.h.

◆ SARA_TX_ENABLE_PORT

#define SARA_TX_ENABLE_PORT   PORT->Group[PA]

Definition at line 125 of file board.h.