fault.h File Reference

Fault handling interface for SRTOS. More...

#include "mcu_macros.h"
#include <stdint.h>

Include dependency graph for fault.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
	__attribute ((naked)) uint32_t *systemGet_Fault_SP(__attribute__((unused)) uint32_t faultLR)
	Returns the Stack Pointer after a fault.
void	systemHandle_Fault (uint32_t *faultSP)
	This function will handle a system fault. The default behavior is to log the fault SP to non-volatile memory.
	__attribute__ ((naked)) void HardFault_Handler()
	This function will get the fault Stack Pointer and call the fault handler.

Detailed Description

Fault handling interface for SRTOS.

Declares fault handling routines for capturing and processing system exceptions.

Definition in file fault.h.

Function Documentation

__attribute()

__attribute

(

(naked)

)

Returns the Stack Pointer after a fault.

Parameters

faultLR

This is the link register, which will be used to return to the function's caller. It is marked unused to suppress the unused paramter compiler warning.

Note

This function will only be called by Inline Assembly.

Warning

This function should not be called by user code.

Definition at line 11 of file fault.c.

{
  __asm volatile ("TST r0, #4\n"
                  "ITE eq\n"
                  "MRSEQ r0, msp\n"
                  "MRSNE r0, psp\n"
                  "BX lr\n");
}

Here is the call graph for this function:

__attribute__()

__attribute__

(

(naked)

)

This function will get the fault Stack Pointer and call the fault handler.

Note

This function is merely an intermediary step to the fault handler. The user should not need to change this function.

Warning

This function should not be called by user code.

Definition at line 79 of file fault.c.

{
  __asm volatile ("MOV r0, lr\n"
                  "BL systemGet_Fault_SP\n"
                  "LDR r1, =systemHandle_Fault\n"
                  "BX r1\n");
}

Here is the caller graph for this function:

systemHandle_Fault()

void systemHandle_Fault

(

uint32_t *

faultSP

)

This function will handle a system fault. The default behavior is to log the fault SP to non-volatile memory.

This function can be editted as the user needs. There is not one specific action that needs to be done here, it just depends on how the user wants to handle faults.

Parameters

faultSP

The fault Stack Pointer that, by default, will be written to non-volatile memory. This will be the best representation of why the system faulted.

Warning

This function must not return.

This function should not be called by user code.

Definition at line 22 of file fault.c.

{
  FLASH_KEYR = FLASH_UNLOCK_KEY1;
  FLASH_KEYR = FLASH_UNLOCK_KEY2;
 
  while (FLASH_SR & (1U << FLASH_SR_BSY_BIT))
    ;
 
  /* PSIZE -> 0b10 which is a 32 bit parallelism size */
  FLASH_CR &= ~(1U << FLASH_CR_PSIZE_BIT_START);
  FLASH_CR &= ~(1U << (FLASH_CR_PSIZE_BIT_START + 1));
  FLASH_CR |= (1U << (FLASH_CR_PSIZE_BIT_START + 1));
 
  while (FLASH_SR & (1U << FLASH_SR_BSY_BIT))
    ;
 
  /* Activate Sector Erase */
  FLASH_CR |= (1U << FLASH_CR_SER_BIT);
 
  /* Erase Sector 7 (FAULT_DATA) */
  FLASH_CR &= ~(0xFU << FLASH_CR_SNB_BIT_START);
  FLASH_CR |= (0x7U << FLASH_CR_SNB_BIT_START);
 
  FLASH_CR |= (1U << FLASH_CR_STRT_BIT);
 
  while (FLASH_SR & (1U << FLASH_SR_BSY_BIT))
    ;
 
  FLASH_CR |= (1U << FLASH_CR_PG_BIT);
 
  /*
   * Push order:
   * r0
   * r1
   * r2
   * r3
   * r12
   * lr
   * pc
   * psr
   * */
 
  volatile uint32_t *curWriteAddr
      = (volatile uint32_t *)FAULT_DATA_FLASH_START_ADDR;
  for (int i = 0; i < 8; i++)
    {
      *(curWriteAddr) = faultSP[i];
      curWriteAddr += 1;
    }
 
  while (FLASH_SR & (1U << FLASH_SR_BSY_BIT))
    ;
 
  while (1)
    ;
}