Utility functionality. More...

#include <stdint.h>
#include <stdbool.h>
#include "em_cmu.h"
#include "em_gpio.h"
#include "util.h"
#include "pin_mapping.h"
#include "debug_dbprint.h"
#include "delay.h"

Functions
static void	initGNDd (void)
	Initialize the initGNDd pin. More...

void	gndd (bool enabled)
	Enable or disable the GNDd pin. More...

void	error (uint8_t number)
	Error method. More...

Variables
uint8_t	errorNumber = 0

bool	GNDd_initialized = false

Detailed Description

Utility functionality.

Version: 4.0

Author: Brecht Van Eeckhoudt

Versions

v1.0: Started with the code from https://github.com/Fescron/Project-LabEmbeddedDesign1/tree/master/code/SLSTK3400A_ADXL362
v1.1: Changed PinModeSet DOUT value to 0 in initLED.
v1.2: Removed unnecessary GPIO_PinOutClear line in initLED.
v1.3: Moved initRTCcomp method from main.c to here, added delay functionality which goes into EM1 or EM2.
v1.4: Moved delay functionality to specific header and source files.
v2.0: Changed Error() to error(), added a global variable to keep the error number and initialize the pin of the LED automatically.
v2.1: Changed initLED to be a static (~hidden) method and also made the global variables static.
v2.2: Added peripheral clock enable/disable functionality for energy saving purposes, only added necessary includes in header file, moved the others to the source file, updated documentation, replaced SysTick delay with RTCC delay, changed error delay length.
v2.3: Changed name of static variable, simplified some logic.
v2.4: Stopped disabling the GPIO clock.
v2.5: Moved documentation.
v2.6: Updated code with new DEFINE checks.
v2.7: Added functionality to send error values using LoRaWAN.
v2.8: Added the ability to enable/disable error forwarding to the cloud using a public definition and changed UART error color.
v3.0: Updated version number.
v3.1: Removed static before the local variables (not necessary).
v4.0: Changed functionality for new board type.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License can be found in the LICENSE file along with this source code.

Some methods use code obtained from examples from Silicon Labs' GitHub. These sections are licensed under the Silabs License Agreement. See the file "Silabs_License_Agreement.txt" for details. Before using this software for any purpose, you must agree to the terms of that agreement.

Definition in file util.c.

Function Documentation

◆ error()

void error ( uint8_t number )

Error method.

ERROR_FORWARDING == 0
The method flashes the LED, displays a UART message and holds the MCU forever in a loop until it gets reset. The error value gets stored in a global variable.

ERROR_FORWARDING == 1
The method sends the error value to the cloud using LoRaWAN if the error number doesn't correspond to LoRaWAN-related functionality (numbers 30 - 55).

Parameters

[in] number The number to indicate where in the code the error was thrown.

Definition at line 122 of file util.c.

 {
     /* Initialize GNDd if not already the case */
     if (!GNDd_initialized) initGNDd();
 
     /* Save the given number in the global variable */
     errorNumber = number;
 
 #if ERROR_FORWARDING == 0 /* ERROR_FORWARDING */
 
 #if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
     dbprint_color(">>> Error (", 5);
     dbprintInt(number);
     dbprintln_color(")! Please reset MCU. <<<", 5);
 #endif /* DEBUG_DBPRINT */
 
     while (1)
     {
         /* Nothing here */
     }
 
 #else /* ERROR_FORWARDING */
 
     /* Check if the error number isn't called in BG96 functionality */
     if ((number < 30) || (number > 55))
     {
 #if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
         dbprint_color(">>> Error (", 5);
         dbprintInt(number);
         dbprintln_color(")! Sending the message to the cloud. <<<", 5);
 #endif /* DEBUG_DBPRINT */
 
 //      initLoRaWAN(); /* Initialize LoRaWAN functionality */
 //
 //      sendStatus(number); /* Send the status value */
 //
 //      disableLoRaWAN(); /* Disable RN2483 */
     }
     else
     {
 
 #if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
         dbprint_color(">>> Error in BG96 functionality (", 5);
         dbprintInt(number);
         dbprintln_color(")! <<<", 5);
 #endif /* DEBUG_DBPRINT */
 
     }
 
 #endif /* ERROR_FORWARDING */
 
 }

◆ gndd()

void gndd ( bool enabled )

Enable or disable the GNDd pin.

This method also initializes the pin-mode if necessary.

Parameters

[in]

enabled

true - Enable GNDd.
false - Disable GNDd.

Definition at line 94 of file util.c.

 {
     /* Initialize GNDd if not already the case */
     if (!GNDd_initialized) initGNDd();
 
     /* Set the selected state */
     if (enabled) GPIO_PinOutSet(DBG_GNDD_PORT, DBG_GNDD_PIN);
     else GPIO_PinOutClear(DBG_GNDD_PORT, DBG_GNDD_PIN);
 }

◆ initGNDd()

static void initGNDd ( void )

static

Initialize the initGNDd pin.

Note: This is a static method because it's only internally used in this file and called by other methods if necessary.

Definition at line 184 of file util.c.

 {
     /* Enable necessary clocks (just in case) */
     CMU_ClockEnable(cmuClock_HFPER, true); /* GPIO is a High Frequency Peripheral */
     CMU_ClockEnable(cmuClock_GPIO, true);
 
     /* In the case of gpioModePushPull, the last argument directly sets the pin state */
     GPIO_PinModeSet(DBG_GNDD_PORT, DBG_GNDD_PIN, gpioModePushPull, 0);
 
 #if DEBUG_DBPRINT == 1 /* DEBUG_DBPRINT */
     dbinfo("GNDd pin initialized");
 #endif /* DEBUG_DBPRINT */
 
     GNDd_initialized = true;
 }

Variable Documentation

◆ errorNumber

uint8_t errorNumber = 0

Definition at line 75 of file util.c.

◆ GNDd_initialized

bool GNDd_initialized = false

Definition at line 76 of file util.c.

Functions

Variables