Choco OS  V.0.16.9.0
Join to the chocolate world
BA - Base Addresses

Module for managing base addresses. More...

Macros

#define oC_BaseAddress_(BASE_NAME)
 returns base address More...
 
#define oC_PowerBaseAddress_(BASE_NAME)
 returns base address for The Power Register More...
 
#define oC_PowerOffset_(BASE_NAME)
 returns offset for The Power Register More...
 
#define oC_PowerBit_(BASE_NAME)
 returns power bit in The Power Register More...
 
#define oC_BaseAddressMask
 Mask for BaseAddress type. More...
 
#define oC_PowerBit_Exist(PowerBit)
 checks if power bit is configured in definition file
 
#define oC_PowerBaseAddress_Exist(Base)
 checks if power register base address is configured in definition file
 
#define oC_PowerOffset_Exist(Offset)
 checks if power register offset is configured in definition file
 
#define oC_PowerBit_ExistFor(BASE_NAME)
 checks if power register bit exist for base with name
 
#define oC_PowerBaseAddress_ExistFor(BASE_NAME)
 checks if power register base address exist for base with name
 
#define oC_PowerOffset_ExistFor(BASE_NAME)
 checks if power register offset exist for base with name
 

Enumerations

Detailed Description

It contains definitions of base addresses with all parameters that are connected to it. All types here are created by using definitions from the oc_ba_defs.h file, that should be defined for each machine family. To add new base address or change an existing entry, edit the oc_ba_defs.h file.
There is a special definition for each base address, that provide information about the Power Register. It is special register, that allows to enable power for a part of memory, that is started at the given base address. The system is enabling power by setting a bit in the given Power Register, that is defined as: power base address, power offset and power bit.

Macro Definition Documentation

#define oC_BaseAddress_ (   BASE_NAME)

The macro is for returning base address from base address name. The value is stored in oC_BaseAddress_t type.

Parameters
BASE_NAMEName of base address from the oc_ba_defs.h file

Definition at line 67 of file oc_ba.h.

#define oC_BaseAddressMask

The macro returns mask with all bits used by oC_BaseAddress_t type set.

Definition at line 116 of file oc_ba.h.

#define oC_PowerBaseAddress_ (   BASE_NAME)

The macro is for returning power base address from base address name. The value is stored in oC_PowerBaseAddress_t type.

The Power Register is a special register, that allows to enable power for part of memory. The power base address is base address of this register.

Parameters
BASE_NAMEName of base address from the oc_ba_defs.h file

Definition at line 80 of file oc_ba.h.

#define oC_PowerBit_ (   BASE_NAME)

The macro is for returning bit index from base address name. The value is stored in oC_PowerBit_t type.

The Power Register is a special register, that allows to enable power for part of memory. The power bit is index of bit in The Power Register, that should be set for enabling the power for the part of memory, where the BASE is situated.

Parameters
BASE_NAMEName of base address from the oc_ba_defs.h file

Definition at line 107 of file oc_ba.h.

#define oC_PowerOffset_ (   BASE_NAME)

The macro is for returning offset for base address name. The value is stored in oC_PowerOffset_t type.

The Power Register is a special register, that allows to enable power for part of memory. The power offset is base address of this register.

Parameters
BASE_NAMEName of base address from the oc_ba_defs.h file

Definition at line 93 of file oc_ba.h.

Enumeration Type Documentation

The type is designed for storing base addresses. It also contains 2 special values:

If you know base address name from the machine documentation, you can use it to receive value from this type by using macro oC_BaseAddress_

Enumerator
oC_BaseAddress_None 

Value for setting when none of base address was set.

oC_BaseAddress_System 

Value for marking system base addresses.

It is used for example in interrupts vector

Definition at line 185 of file oc_ba.h.

The type is for storing base address of the power register. Value of this type is set from the oC_BaseAddress_t type.

See also
oC_PowerBaseAddress_

Definition at line 203 of file oc_ba.h.

The type is for storing index of bit in the Power Register, that need to be set to enable memory started at the given base address name.

See also
oC_PowerBit_

Definition at line 235 of file oc_ba.h.

The type is for storing offset of the power register.

See also
oC_PowerOffset_

Definition at line 219 of file oc_ba.h.