Remove other '_s' suffix from structs

Most of the work is already done by [1].
Remove few more '_s' suffix and also fix some comment referring to
the old name of the struct.

Link: https://review.openocd.org/c/openocd/+/8340
Change-Id: Ifddc401c3b05e62ece3aa7926af1e78f0c4a671e
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/8341
Reviewed-by: zapb <dev@zapb.de>
Tested-by: jenkins
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
This commit is contained in:
Antonio Borneo 2024-06-15 17:57:25 +02:00
parent 6b984a54c9
commit 67be8188bb
6 changed files with 16 additions and 16 deletions

View File

@ -32,18 +32,18 @@ struct flash_sector {
uint32_t size; uint32_t size;
/** /**
* Indication of erasure status: 0 = not erased, 1 = erased, * Indication of erasure status: 0 = not erased, 1 = erased,
* other = unknown. Set by @c flash_driver_s::erase_check only. * other = unknown. Set by @c flash_driver::erase_check only.
* *
* This information must be considered stale immediately. * This information must be considered stale immediately.
* Don't set it in flash_driver_s::erase or a device mass_erase * Don't set it in flash_driver::erase or a device mass_erase
* Don't clear it in flash_driver_s::write * Don't clear it in flash_driver::write
* The flag is not used in a protection block * The flag is not used in a protection block
*/ */
int is_erased; int is_erased;
/** /**
* Indication of protection status: 0 = unprotected/unlocked, * Indication of protection status: 0 = unprotected/unlocked,
* 1 = protected/locked, other = unknown. Set by * 1 = protected/locked, other = unknown. Set by
* @c flash_driver_s::protect_check. * @c flash_driver::protect_check.
* *
* This information must be considered stale immediately. * This information must be considered stale immediately.
* A million things could make it stale: power cycle, * A million things could make it stale: power cycle,
@ -67,7 +67,7 @@ struct flash_sector {
* a major interface. * a major interface.
* *
* This structure will be passed as a parameter to the callbacks in the * This structure will be passed as a parameter to the callbacks in the
* flash_driver_s structure, some of which may modify the contents of * flash_driver structure, some of which may modify the contents of
* this structure of the area of flash that it defines. Driver writers * this structure of the area of flash that it defines. Driver writers
* may use the @c driver_priv member to store additional data on a * may use the @c driver_priv member to store additional data on a
* per-bank basis, if required. * per-bank basis, if required.

View File

@ -29,7 +29,7 @@ struct flash_bank;
* flash bank DRIVERNAME ...parameters... * flash bank DRIVERNAME ...parameters...
* @endcode * @endcode
* *
* OpenOCD will search for the driver with a @c flash_driver_s::name * OpenOCD will search for the driver with a @c flash_driver::name
* that matches @c DRIVERNAME. * that matches @c DRIVERNAME.
* *
* The flash subsystem calls some of the other drivers routines a using * The flash subsystem calls some of the other drivers routines a using
@ -170,7 +170,7 @@ struct flash_driver {
/** /**
* Check the erasure status of a flash bank. * Check the erasure status of a flash bank.
* When called, the driver routine must perform the required * When called, the driver routine must perform the required
* checks and then set the @c flash_sector_s::is_erased field * checks and then set the @c flash_sector::is_erased field
* for each of the flash banks's sectors. * for each of the flash banks's sectors.
* *
* @param bank The bank to check * @param bank The bank to check
@ -182,7 +182,7 @@ struct flash_driver {
* Determine if the specific bank is "protected" or not. * Determine if the specific bank is "protected" or not.
* When called, the driver routine must must perform the * When called, the driver routine must must perform the
* required protection check(s) and then set the @c * required protection check(s) and then set the @c
* flash_sector_s::is_protected field for each of the flash * flash_sector::is_protected field for each of the flash
* bank's sectors. * bank's sectors.
* *
* If protection is not implemented, set method to NULL * If protection is not implemented, set method to NULL
@ -204,7 +204,7 @@ struct flash_driver {
int (*info)(struct flash_bank *bank, struct command_invocation *cmd); int (*info)(struct flash_bank *bank, struct command_invocation *cmd);
/** /**
* A more gentle flavor of flash_driver_s::probe, performing * A more gentle flavor of flash_driver::probe, performing
* setup with less noise. Generally, driver routines should test * setup with less noise. Generally, driver routines should test
* to see if the bank has already been probed; if it has, the * to see if the bank has already been probed; if it has, the
* driver probably should not perform its probe a second time. * driver probably should not perform its probe a second time.

View File

@ -92,7 +92,7 @@ struct pic32mx_flash_bank {
* DEVID values as per PIC32MX Flash Programming Specification Rev N * DEVID values as per PIC32MX Flash Programming Specification Rev N
*/ */
static const struct pic32mx_devs_s { static const struct pic32mx_devs {
uint32_t devid; uint32_t devid;
const char *name; const char *name;
} pic32mx_devs[] = { } pic32mx_devs[] = {

View File

@ -15,7 +15,7 @@
#define OPENOCD_JTAG_COMMANDS_H #define OPENOCD_JTAG_COMMANDS_H
/** /**
* The inferred type of a scan_command_s structure, indicating whether * The inferred type of a scan_command structure, indicating whether
* the command has the host scan in from the device, the host scan out * the command has the host scan in from the device, the host scan out
* to the device, or both. * to the device, or both.
*/ */
@ -29,7 +29,7 @@ enum scan_type {
}; };
/** /**
* The scan_command provide a means of encapsulating a set of scan_field_s * The scan_command provide a means of encapsulating a set of scan_field
* structures that should be scanned in/out to the device. * structures that should be scanned in/out to the device.
*/ */
struct scan_command { struct scan_command {
@ -123,7 +123,7 @@ union jtag_command_container {
/** /**
* The type of the @c jtag_command_container contained by a * The type of the @c jtag_command_container contained by a
* @c jtag_command_s structure. * @c jtag_command structure.
*/ */
enum jtag_command_type { enum jtag_command_type {
JTAG_SCAN = 1, JTAG_SCAN = 1,

View File

@ -331,7 +331,7 @@ union xtensa_reg_val_u {
uint8_t buf[4]; uint8_t buf[4];
}; };
static const struct xtensa_keyval_info_s xt_qerr[XT_QERR_NUM] = { static const struct xtensa_keyval_info xt_qerr[XT_QERR_NUM] = {
{ .chrval = "E00", .intval = ERROR_FAIL }, { .chrval = "E00", .intval = ERROR_FAIL },
{ .chrval = "E01", .intval = ERROR_FAIL }, { .chrval = "E01", .intval = ERROR_FAIL },
{ .chrval = "E02", .intval = ERROR_COMMAND_ARGUMENT_INVALID }, { .chrval = "E02", .intval = ERROR_COMMAND_ARGUMENT_INVALID },

View File

@ -97,7 +97,7 @@ enum xtensa_ar_scratch_set_e {
XT_AR_SCRATCH_NUM XT_AR_SCRATCH_NUM
}; };
struct xtensa_keyval_info_s { struct xtensa_keyval_info {
char *chrval; char *chrval;
int intval; int intval;
}; };
@ -283,7 +283,7 @@ struct xtensa {
bool halt_request; bool halt_request;
uint32_t nx_stop_cause; uint32_t nx_stop_cause;
uint32_t nx_reg_idx[XT_NX_REG_IDX_NUM]; uint32_t nx_reg_idx[XT_NX_REG_IDX_NUM];
struct xtensa_keyval_info_s scratch_ars[XT_AR_SCRATCH_NUM]; struct xtensa_keyval_info scratch_ars[XT_AR_SCRATCH_NUM];
bool regs_fetched; /* true after first register fetch completed successfully */ bool regs_fetched; /* true after first register fetch completed successfully */
}; };