hla: API: specify that read_reg/write_reg use regsel as parameter

The API of hla have been defined from ST-Link basic operations.
By chance, all the current implementation of hla (st-link, ti-icdi
and nulink) share the same way to handle the parameter 'num' of
the API read_reg() and write_reg(), that is simply using it to
initialize the field REGSEL (bits [6:0]) of armv7m Debug Core
Register Selector Register (DCRSR).

Add a comment in the API definition to highlight this, in case it
get used by a further hla implementation, then rename as 'regsel'
the 'num' parameter.

Change-Id: I4b6a2c7d78b4fc4de2b9b2bdba065414b15c6ba3
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/5882
Reviewed-by: Edward Fewell <edwardfewell@hotmail.com>
Tested-by: jenkins
Reviewed-by: Zale Yu
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
This commit is contained in:
Antonio Borneo
2020-10-25 14:59:13 +01:00
parent 62394a6b1c
commit be631eed16
4 changed files with 31 additions and 16 deletions

View File

@@ -51,10 +51,25 @@ struct hl_layout_api_s {
int (*step)(void *handle);
/** */
int (*read_regs)(void *handle);
/** */
int (*read_reg)(void *handle, int num, uint32_t *val);
/** */
int (*write_reg)(void *handle, int num, uint32_t val);
/**
* Read one register from the target
*
* @param handle A pointer to the device-specific handle
* @param regsel Register selection index compatible with all the
* values allowed by armv7m DCRSR.REGSEL
* @param val A pointer to retrieve the register value
* @returns ERROR_OK on success, or an error code on failure.
*/
int (*read_reg)(void *handle, unsigned int regsel, uint32_t *val);
/**
* Write one register to the target
* @param handle A pointer to the device-specific handle
* @param regsel Register selection index compatible with all the
* values allowed by armv7m DCRSR.REGSEL
* @param val The value to be written in the register
* @returns ERROR_OK on success, or an error code on failure.
*/
int (*write_reg)(void *handle, unsigned int regsel, uint32_t val);
/** */
int (*read_mem)(void *handle, uint32_t addr, uint32_t size,
uint32_t count, uint8_t *buffer);