Hardware abstraction layer endpoint

This endpoint is intended for receiving the values of HAL parameters, working with privileged registers, clearing the processor cache, and diagnostic output.

Information about methods of the endpoint is provided in the table below.

Methods of the hal.HAL endpoint (kl.core.HAL interface)

Method	Method purpose and parameters	Potential danger of the method
`GetEnv`	Purpose Lets you get the value of a HAL parameter. Parameters [in] `name` – name of the parameter. [out] `value` – value of the parameter. [out] `rc` – return code.	Lets you get values of HAL parameters that could contain critical system information.
`GetPrivReg`	Purpose Lets you get the value of a privileged register. Parameters [in] `reg` – name of the register. [out] `val` – value of the register. [out] `rc` – return code.	Lets you set up a data transfer channel with a process that has access to the `SetPrivReg` or `SetPrivRegRange` method. It is recommended to monitor the name of a register.
`SetPrivReg`	Purpose Sets the value of a privileged register. Parameters [in] `reg` – name of the register. [in] `val` – value of the register. [out] `rc` – return code.	Allows the following: Set the value of a privileged register. Set up a data transfer channel with a process that has access to the `GetPrivReg` or `GetPrivRegRange` method. It is recommended to monitor the name of a register.
`GetPrivRegRange`	Purpose Lets you get the value of a privileged register. Parameters [in] `regRange` – name of the registers range. [in] `offset` – register offset in the registers range. [out] `val` – value of the register. [out] `rc` – return code.	Lets you set up a data transfer channel with a process that has access to the `SetPrivReg` or `SetPrivRegRange` method. It is recommended to monitor the name of the registers range and the register offset in this range.
`SetPrivRegRange`	Purpose Sets the value of a privileged register. Parameters [in] `regRange` – name of the registers range. [in] `offset` – register offset in the registers range. [in] `val` – value of the register. [out] `rc` – return code.	Allows the following: Set the value of a privileged register. Set up a data transfer channel with a process that has access to the `GetPrivReg` or `GetPrivRegRange` method. It is recommended to monitor the name of the registers range and the register offset in this range.
`FlushCache`	Purpose Clears the processor cache. Parameters [in] `type` – value defining the cache type (data cache, instructions cache, or joint data and instructions cache). [in] `va` – base address of the virtual memory region. The cache corresponding to this region is cleared. [in] `size` – size of the virtual memory region. The cache corresponding to this region is cleared. [out] `rc` – return code.	Allows the processor cache to be cleared.
`DebugWrite`	Purpose Puts data into the diagnostic output that is written, for example, to a COM port or USB port (version 3.0 or later, with DbC support). Parameters [in] `data` – sequence containing the data to be put into the diagnostic output. [out] `rc` – return code.	Lets you populate diagnostic output with fictitious (uninformative) data.

Page top