module ti.sysbios.family.c64p.MemoryProtect

MemoryProtect Module

C synopsis
Individual elements
Configuration settings
Individual elements

This module provide an API to get and to set the permission attributes of a memory range. A memory range can be set to user executable, user writable, user readable, supervisor executable, supervisor writable, or supervisor readable. Setting a memory range to only user readable, writable or executable should be done with caution because BIOS executes in supervisor mode. Whenever setting the permission attributes of a memory range, the local CPU access field must be set, if the local CPU accesses the memory range. If the local field is not set, an exception is generated if the CPU tries to access the memory range. [ more ... ]

C synopsis target-domain sourced in ti/sysbios/family/c64p/MemoryProtect.xdc

#include <ti/sysbios/family/c64p/MemoryProtect.h>

Functions
Bool	MemoryProtect_getPA// Gets the PA (Permission Attribute) corresponding to addr(Ptr addr, UInt32 *paMask);
Bool	MemoryProtect_setPA// Sets the PA (Permission Attribute) corresponding to addr/size(Ptr addr, SizeT size, UInt32 paMask);
Bool	MemoryProtect_setXMCRegion// Set XMC region mapping and permission attributes(Int8 id, Ptr baseAddr, MemoryProtect_RegionSize size, Ptr rAddr35_12, UInt32 paMask);
Functions common to all target modules
	MemoryProtect_Module_getMask// Returns the diagnostics mask for this module, MemoryProtect_Module_hasMask// Test whether this module has a diagnostics mask, MemoryProtect_Module_heap// The heap from which this module allocates memory, MemoryProtect_Module_id// Get this module's unique id, MemoryProtect_Module_setMask// Set the diagnostics mask for this module, MemoryProtect_Module_startupDone// Test if this module has completed startup
Defines
#define	MemoryProtect_MPPA_LOCAL// Local CPU may access (UInt32)0x00000100
#define	MemoryProtect_MPPA_SR// Supervisor mode read (UInt32)0x00000020
#define	MemoryProtect_MPPA_SW// Supervisor mode may write (UInt32)0x00000010
#define	MemoryProtect_MPPA_SX// Supervisor mode may execute (UInt32)0x00000008
#define	MemoryProtect_MPPA_UR// User mode may read (UInt32)0x00000004
#define	MemoryProtect_MPPA_UW// User mode may write (UInt32)0x00000002
#define	MemoryProtect_MPPA_UX// User mode may execute (UInt32)0x00000001
#define	MemoryProtect_numXMCRegions// (UInt)16
Typedefs
typedef enum	MemoryProtect_RegionSize// ...

DETAILS

This module is to be used in correlation with the Exception module. When this module is in use, external exceptions are enabled by default. Any memory protection fault which arises generates an exception. This exception is processed and decoded by the Exception module.

An example of setting Local L2 RAM to be supervisor read-only and CPU accessible:

    UInt32 paMask;
    paMask = MemoryProtect_MPPA_LOCAL |
             MemoryProtect_MPPA_SR;
              
    MemoryProtect_setPA((Ptr)0x11800000, 0x40000, paMask);

Calling Context

Function	Hwi	Swi	Task	Main	Startup
getPA	Y	Y	Y	Y	Y
setPA	Y	Y	Y	Y	Y
Definitions: Hwi: API is callable from a Hwi thread. Swi: API is callable from a Swi thread. Task: API is callable from a Task thread. Main: API is callable during any of these phases: In your module startup after this module is started (e.g. Mod_Module_startupDone() returns TRUE). During xdc.runtime.Startup.lastFxns. During main(). During BIOS.startupFxns. Startup: API is callable during any of these phases: During xdc.runtime.Startup.firstFxns. In your module startup before this module is started (e.g. Mod_Module_startupDone() returns FALSE).

const MemoryProtect_MPPA_LOCAL