API Reference: Libraries

Top

# halK

#### NAME

> halK - KONTRON Hal

#### ROUTINES

> halRegister( ) - register hal driver
> halBoardInfoGet( ) - retrieve the board info
> halBoardInfoShow( ) - print the board info
> halTopMemGet( ) - get the top of the memory
> halCpuBusClockGet( ) - get the CPU bus clock frequency

#### DESCRIPTION

> KONTRON HAL.
> This driver serves as an abstraction layer to obtain hardware specific information
> about the board in use. For some boards additional functions to handle hardware
> dependent features are available. The provided functions and information are individual
> for each board or board family.

> The board information is encapsulated in the BOARD_INFO structure
> (defined in kontron/src/hwif/h/multi/halK.h):

>     typedef struct board_info {
>         const char *boardName; // human readable board name
>         const char *ident;     // board IDENT number
>         const char *serialNb;  // board serial number
>         const char *biosVendor;
>         const char *biosVersion;
>         const char *biosDate; // BIOS release date
>         UINT8 biosRev_hi; // BIOS revision high number
>         UINT8 biosRev_lo; // BIOS revision low number
>         UINT32 mainMemSize; // size of the main memory
>         UINT32 cpuBusClock; // CPU bus clock frequency
>     } BOARD_INFO;

API Reference: Routines

Top

# halRegister( )

#### NAME

> halRegister( ) - register hal driver

#### DESCRIPTION

> This routine registers the hal driver with the VxBus subsystem.

> This routine contains the first instructions of the device driver that are ever executed within a VxWorks system. This function registers the driver with VxBus by providing pointers to the data structures listed previously. Once this step is complete, VxWorks is able to associate this driver with appropriate hardware within the system to form an instance.

#### RETURNS

> N/A

#### ERRNO

> Not Available

#### SEE ALSO

> halK

API Reference: Routines

Top

# halBoardInfoGet( )

#### NAME

> halBoardInfoGet( ) - retrieve the board info

#### DESCRIPTION

> This function utilizes the driver method vxbHalBoardInfoGet to retrieve the board information encapsulated in the BOARD_INFO structure (defined in kontron/src/hwif/h/multi/halK.h)

#### RETURNS

> pointer to BOARD_INFO structure or NULL if the information cannot be retrieved.

#### ERRNO

> Not Available

#### SEE ALSO

> halK

API Reference: Routines

Top

# halBoardInfoShow( )

#### NAME

> halBoardInfoShow( ) - print the board info

#### DESCRIPTION

> This function utilizes the driver method to print the board info on the system console.

#### RETURNS

> OK, or ERROR if functionality is not retrieved.

#### ERRNO

> Not Available

#### SEE ALSO

> halK

API Reference: Routines

Top

# halTopMemGet( )

#### NAME

> halTopMemGet( ) - get the top of the memory

#### DESCRIPTION

> This routine gets the top of the lower memory below 4GB.

#### RETURNS

> pointer to top of the memory

#### ERRNO

> Not Available

#### SEE ALSO

> halK

API Reference: Routines

Top

# halCpuBusClockGet( )

#### NAME

> halCpuBusClockGet( ) - get the CPU bus clock frequency

#### DESCRIPTION

> This routine gets the CPU bus clock frequency

#### RETURNS

> bus clock frequency

#### ERRNO

> Not Available

#### SEE ALSO

> halK