Choco OS  V.0.16.9.0
Join to the chocolate world
oc_mem_lld.h File Reference

The file with LLD interface for the MEM driver. More...

#include <oc_machine.h>
#include <oc_errors.h>
#include <stdbool.h>
#include <oc_mcs.h>

Go to the source code of this file.

Data Structures

struct  oC_MEM_LLD_MemoryRegionConfig_t
 stores configuration of the memory region More...
 

Macros

#define oC_MEM_LLD_MEMORY_ALIGNMENT
 number of bytes in memory alignment More...
 
#define oC_MEM_LLD_STACK_ALIGNMENT
 number of bytes in alignment of the stack
 

Typedefs

typedef oC_UInt_t oC_MEM_LLD_Size_t
 type for storing size of memory
 
typedef void(* oC_MEM_LLD_Interrupt_t) (void)
 type for storing memory interrupt pointers More...
 

Enumerations

Functions

oC_ErrorCode_t oC_MEM_LLD_TurnOnDriver (void)
 initializes the driver to work More...
 
oC_ErrorCode_t oC_MEM_LLD_TurnOffDriver (void)
 release the driver More...
 
void * oC_MEM_LLD_GetRamStartAddress (void)
 returns start address of the RAM More...
 
void * oC_MEM_LLD_GetRamEndAddress (void)
 returns end address of the RAM More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetRamSize (void)
 returns size of the ram More...
 
void * oC_MEM_LLD_GetDmaRamStartAddress (void)
 returns start address of the DMA RAM More...
 
void * oC_MEM_LLD_GetDmaRamEndAddress (void)
 returns end address of the DMA RAM More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetDmaRamSize (void)
 returns size of the DMA ram More...
 
void * oC_MEM_LLD_GetFlashStartAddress (void)
 returns start address of the flash More...
 
void * oC_MEM_LLD_GetFlashEndAddress (void)
 returns end address of the flash More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetFlashSize (void)
 returns size of the flash section More...
 
void * oC_MEM_LLD_GetHeapStartAddress (void)
 returns start address of the heap More...
 
void * oC_MEM_LLD_GetHeapEndAddress (void)
 returns end address of the heap More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetHeapSize (void)
 returns size of the heap More...
 
void * oC_MEM_LLD_GetStackStartAddress (void)
 returns start address of the stack More...
 
void * oC_MEM_LLD_GetStackEndAddress (void)
 returns end address of the stack More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetStackSize (void)
 returns size of the stack More...
 
void * oC_MEM_LLD_GetDataStartAddress (void)
 returns start address of the data section More...
 
void * oC_MEM_LLD_GetDataEndAddress (void)
 returns end address of the data section More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetDataSize (void)
 returns size of the data section More...
 
void * oC_MEM_LLD_GetBssStartAddress (void)
 returns start address of the Bss section More...
 
void * oC_MEM_LLD_GetBssEndAddress (void)
 returns end address of the Bss section More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetBssSize (void)
 returns size of the Bss section More...
 
void * oC_MEM_LLD_GetUsedFlashStartAddress (void)
 returns start address of the used flash section More...
 
void * oC_MEM_LLD_GetUsedFlashEndAddress (void)
 returns used flash end address More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetUsedFlashSize (void)
 returns size of the used flash section More...
 
oC_MEM_LLD_Size_t oC_MEM_LLD_GetAlignmentSize (void)
 returns size of alignment More...
 
bool oC_MEM_LLD_IsRamAddress (const void *Address)
 checks if the pointer is in ram section More...
 
bool oC_MEM_LLD_IsFlashAddress (const void *Address)
 checks if the pointer is in flash section More...
 
bool oC_MEM_LLD_IsUsedFlashAddress (const void *Address)
 checks if the pointer is in used flash section More...
 
bool oC_MEM_LLD_IsHeapAddress (const void *Address)
 checks if the pointer is in heap section More...
 
bool oC_MEM_LLD_IsExternalAddress (const void *Address)
 checks if the pointer is in external section More...
 
bool oC_MEM_LLD_IsDmaRamAddress (const void *Address)
 checks if the pointer is in DMA RAM section More...
 
oC_ErrorCode_t oC_MEM_LLD_SetMemoryFaultInterrupt (oC_MEM_LLD_Interrupt_t Interrupt)
 sets interrupt handler for memory fault More...
 
oC_ErrorCode_t oC_MEM_LLD_SetBusFaultInterrupt (oC_MEM_LLD_Interrupt_t Interrupt)
 sets interrupt handler for bus fault More...
 
oC_ErrorCode_t oC_MEM_LLD_TurnOnMemoryFaultInterrupt (void)
 turns on memory fault interrupt More...
 
oC_ErrorCode_t oC_MEM_LLD_TurnOffMemoryFaultInterrupt (void)
 turns off memory fault interrupt More...
 
oC_ErrorCode_t oC_MEM_LLD_TurnOnBusFaultInterrupt (void)
 turns on bus fault interrupt More...
 
oC_ErrorCode_t oC_MEM_LLD_TurnOffBusFaultInterrupt (void)
 turns off bus fault interrupt More...
 
bool oC_MEM_LLD_IsMemoryFaultInterruptTurnedOn (void)
 checks if memory fault interrupt is turned on More...
 
bool oC_MEM_LLD_IsBusFaultInterruptTurnedOn (void)
 checks if bus fault interrupt is turned on More...
 
oC_ErrorCode_t oC_MEM_LLD_ConfigureMemoryRegion (oC_MEM_LLD_MemoryRegionConfig_t *Config)
 configures memory region More...
 
bool oC_MEM_LLD_SetMemoryAccessMode (oC_MEM_LLD_MemoryAccessMode_t Mode)
 Change current memory access mode. More...
 
oC_MEM_LLD_MemoryAccessMode_t oC_MEM_LLD_GetMemoryAccessMode (void)
 returns currently configured memory access mode More...
 

Detailed Description


Author
Patryk Kubiak - (Created on: 27 04 2015 17:07:50)
Note
Copyright (C) 2015 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om
           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 2 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.

           You should have received a copy of the GNU General Public License
           along with this program; if not, write to the Free Software
           Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

Definition in file oc_mem_lld.h.