Skip to content

Commit

Permalink
lib: stm32wba: fix formatting & typos
Browse files Browse the repository at this point in the history
Fix formatting issues & typos

Signed-off-by: Abderrahmane Jarmouni <[email protected]>
  • Loading branch information
ajarmouni-st authored and erwango committed Jan 16, 2024
1 parent 5b450f5 commit bb66261
Show file tree
Hide file tree
Showing 23 changed files with 127 additions and 137 deletions.
70 changes: 37 additions & 33 deletions lib/stm32wba/hci/README
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Origin:
https://github.com/STMicroelectronics/STM32CubeWBA

Status:
version v1.1.2
version v1.2.0

Purpose:
This library is used on STM32WBA series to port BLE controller library in
Expand Down Expand Up @@ -41,37 +41,37 @@ Description:
Middlewares/ST/STM32_WPAN/link_layer/ll_sys/src/ll_sys_startup.c
Middlewares/ST/STM32_WPAN/link_layer/ll_sys/inc/ll_sys_startup.h
Middlewares/ST/STM32_WPAN/stm32_wpan_common.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/Core/Inc/app_common.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/Core/Inc/app_conf.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/Core/Inc/app_entry.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/Core/Inc/utilities_conf.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/Core/Inc/main.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/rf_timing_synchro.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/rf_timing_synchro.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_driver.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_driver.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_manager.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_manager.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/debug_signals.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/Core/Inc/app_common.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/Core/Inc/app_conf.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/Core/Inc/app_entry.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/Core/Inc/utilities_conf.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/Core/Inc/main.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/rf_timing_synchro.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/rf_timing_synchro.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_driver.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_driver.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_manager.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/Flash/flash_manager.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/debug_signals.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/RTDebug.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/RTDebug.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/local_debug_tables.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/scm.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/scm.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/stm_list.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/stm_list.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Modules/utilities_common.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw_aes.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw_if.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw_pka.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Interfaces/pka_p256.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Config/Log/log_module.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Config/Log/log_module.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Config/Debug_GPIO/app_debug.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/System/Config/Debug_GPIO/debug_config.h
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/STM32_WPAN/Target/power_table.c
Projects/NUCLEO-WBA52CG/Applications/BLE/BLE_HeartRate/STM32_WPAN/Target/bpka.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/RTDebug.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/RTDebug/local_debug_tables.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/scm.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/scm.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/stm_list.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/stm_list.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Modules/utilities_common.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw_aes.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw_if.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Interfaces/hw_pka.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Interfaces/pka_p256.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Config/Log/log_module.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Config/Log/log_module.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Config/Debug_GPIO/app_debug.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/System/Config/Debug_GPIO/debug_config.h
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/STM32_WPAN/Target/power_table.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/STM32_WPAN/Target/bpka.c
Projects/NUCLEO-WBA55CG/Applications/BLE/BLE_HeartRate/STM32_WPAN/Target/bpka.h
Utilities/trace/adv_trace/stm32_adv_trace.h
Utilities/misc/stm32_mem.h
Expand All @@ -85,8 +85,8 @@ Dependencies:
URL:
https://github.com/STMicroelectronics/STM32CubeWBA

commit:
v1.2.0
Commit:
d2bde9968677fdfd302e2b595239721e3c178e88

Maintained-by:
External
Expand All @@ -109,3 +109,7 @@ Patch List:
main.h
app_conf.h
scm.c

* Changes from official delivery:
- dos2unix applied
- trailing white spaces removed
6 changes: 3 additions & 3 deletions lib/stm32wba/hci/ble_bufsize.h
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,11 @@
* BLE_FIXED_BUFFER_SIZE_BYTES:
* A part of the RAM, is dynamically allocated by initializing all the pointers
* defined in a global context variable "mem_alloc_ctx_p".
* This initialization is made in the Dynamic_allocator functions, which
* This initialization is made in the Dynamic_allocator functions, which
* assign a portion of RAM given by the external application to the above
* mentioned "global pointers".
*
* The size of this Dynamic RAM is made of 2 main components:
* The size of this Dynamic RAM is made of 2 main components:
* - a part that is parameters-dependent (num of links, GATT buffers, ...),
* and which value is made explicit by the following macro;
* - a part, that may be considered "fixed", i.e. independent from the above
Expand All @@ -103,7 +103,7 @@
#else
#define BLE_PER_LINK_SIZE_BYTES 188 /* Full stack */
#endif

/*
* BLE_TOTAL_BUFFER_SIZE: this macro returns the amount of memory, in bytes,
* needed for the storage of data structures (except GATT database elements)
Expand Down
4 changes: 2 additions & 2 deletions lib/stm32wba/hci/ble_const.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
* To change the size of commands and events parameters used in the
* auto-generated files, you need to update 2 defines:
*
* - BLE_CMD_MAX_PARAM_LEN
* - BLE_EVT_MAX_PARAM_LEN
* - BLE_CMD_MAX_PARAM_LEN
* - BLE_EVT_MAX_PARAM_LEN
*
* These 2 defines are set below with default values and can be changed.
*
Expand Down
18 changes: 9 additions & 9 deletions lib/stm32wba/hci/ble_defs.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
#define BLE_STATUS_IRK_NOT_FOUND 0x5BU

/* A search for a specific remote device was unsuccessful because no entry
* exists either into NVM Database or in volatile database.
* exists either into NVM Database or in volatile database.
*/
#define BLE_STATUS_DEV_NOT_FOUND 0x5CU

Expand All @@ -59,9 +59,9 @@
*/
#define BLE_STATUS_OUT_OF_HANDLE 0x61U

/* The requested GATT operation is not allowed in this context/status or using
* the provided parameters.
* This is a specific GATT error, different from generic Not Allowed error,
/* The requested GATT operation is not allowed in this context/status or using
* the provided parameters.
* This is a specific GATT error, different from generic Not Allowed error,
* because it refers to specific GATT specifications/rules.
*/
#define BLE_STATUS_INVALID_OPERATION 0x62U
Expand All @@ -75,7 +75,7 @@

/* Notification/Indication can't be sent to the requested remote device because
* it doesn't satisfy the needed security permission.
*/
*/
#define BLE_STATUS_SEC_PERMISSION_ERROR 0x65U

/* The address of the device could not be resolved using the IRK stored\n
Expand Down Expand Up @@ -124,8 +124,8 @@
#define BLE_STATUS_BUSY 0x93U

/* The operation requested cannot be completed immediately by the Host
* (usually because of lack of resources).
* The operation is generally put on hold by the caller and it's usually
* (usually because of lack of resources).
* The operation is generally put on hold by the caller and it's usually
* retried on later time.
*/
#define BLE_STATUS_PENDING 0x95U
Expand All @@ -136,7 +136,7 @@
#define BLE_STATUS_ERROR 0x97U

/* The requested operation failed because of lack of memory.
* Out of memory shall be returned for situations where memory will never
* Out of memory shall be returned for situations where memory will never
* become available again (e.g. ATT database)
*/
#define BLE_STATUS_OUT_OF_MEMORY 0x98U
Expand Down Expand Up @@ -208,7 +208,7 @@
#define GAP_ADD_DEV_MODE_RESOLVING_LIST_ONLY 0x00U
#define GAP_ADD_DEV_MODE_CLEAR 0x01U
#define GAP_ADD_DEV_MODE_FILTER_ACC_LIST_ONLY 0x02U
#define GAP_ADD_DEV_MODE_BOTH_LISTS 0x04U
#define GAP_ADD_DEV_MODE_BOTH_LISTS 0x04U

/* ------------------------------------------------------------------------- */

Expand Down
18 changes: 9 additions & 9 deletions lib/stm32wba/hci/blestack.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,25 +61,25 @@ enum
/*
* This structure contains memory and low level hardware configuration data
* for the device
*/
*/
typedef struct
{

/* Start address of the RAM buffer allocated for BLE stack library.
* It must be a 32bit aligned RAM area.
*/
*/
uint8_t* bleStartRamAddress;

/* Size of the RAM buffer allocated for BLE stack library.
* (could be filled with BLE_TOTAL_BUFFER_SIZE return value)
*/
uint32_t total_buffer_size;
uint32_t total_buffer_size;

/* Start address of the RAM buffer allocated for GATT database.
* It must be a 32bit aligned RAM area.
*/
*/
uint8_t* bleStartRamAddress_GATT;

/* Size of the RAM buffer allocated for GATT database.
* (could be filled with BLE_TOTAL_BUFFER_SIZE_GATT return value)
*/
Expand All @@ -101,7 +101,7 @@ typedef struct
* used in the calculation of BLE_TOTAL_BUFFER_SIZE_GATT)
*/
uint16_t numAttrServ;

/* Size of the storage area for Attribute values (ATT_VALUE_ARRAY_SIZE used
* in the calculation of BLE_TOTAL_BUFFER_SIZE_GATT)
* This value depends on the number of attributes used by application. In
Expand Down Expand Up @@ -156,7 +156,7 @@ typedef struct
* - bit 1: 1: no service change desc. 0: with service change desc.
* - bit 2: 1: device name Read-Only 0: device name R/W
* - bit 3: 1: extended adv supported 0: extended adv not supported
* - bit 5: 1: Reduced GATT db in NVM 0: Full GATT db in NVM
* - bit 5: 1: Reduced GATT db in NVM 0: Full GATT db in NVM
* - bit 6: 1: GATT caching is used 0: GATT caching is not used
* - bit 7: 1: LE Power Class 1 0: LE Power Class 2-3
* - bit 8: 1: appearance Writable 0: appearance Read-Only
Expand Down Expand Up @@ -192,9 +192,9 @@ extern tBleStatus BleStack_Init( const BleStack_init_t* init_params_p );
* It has to be executed regularly to process incoming Link Layer packets and
* to process Host Layers procedures. All stack callbacks are called by this
* function.
*
*
* No BLE stack function must be called while the BleStack_Process is running.
* For example, if a BLE stack function may be called inside an
* For example, if a BLE stack function may be called inside an
* interrupt routine, that interrupt must be disabled during the execution of
* BleStack_Process().
*
Expand Down
4 changes: 2 additions & 2 deletions lib/stm32wba/hci/linklayer_plat.h
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ extern void LINKLAYER_PLAT_DisableIRQ(void);
* This parameter can be one of the following:
* @arg LL_HIGH_ISR_ONLY: enable link layer high priority ISR.
* @arg LL_LOW_ISR_ONLY: enable link layer SW low priority ISR.
* @arg SYS_LOW_ISR: unmask interrupts for all the other system ISR with
* @arg SYS_LOW_ISR: unmask interrupts for all the other system ISR with
* lower priority that link layer SW low interrupt.
* @retval None
*/
Expand All @@ -118,7 +118,7 @@ extern void LINKLAYER_PLAT_EnableSpecificIRQ(uint8_t isr_type);
* This parameter can be one of the following:
* @arg LL_HIGH_ISR_ONLY: disable link layer high priority ISR.
* @arg LL_LOW_ISR_ONLY: disable link layer SW low priority ISR.
* @arg SYS_LOW_ISR: mask interrupts for all the other system ISR with
* @arg SYS_LOW_ISR: mask interrupts for all the other system ISR with
* lower priority that link layer SW low interrupt.
* @retval None
*/
Expand Down
4 changes: 2 additions & 2 deletions lib/stm32wba/hci/ll/bsp.h
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
#define PRIORITY_LEVEL_MASK 0x0F

/**
* This macros specify the different combinations that can be used to enable or disable
* This macros specify the different combinations that can be used to enable or disable
* a specific ISR
*/

Expand Down Expand Up @@ -516,7 +516,7 @@ void bsp_switch_to_lw_isr(uint8_t priority);
void bsp_wait_for_busclkrdy(void);
/**
* @brief used to start temperature calculations
* if the upper layer has informed the link layer by the existence of temperature sensor through @ref ll_intf_set_temperature_sensor_stat() or llhwc_cmn_set_temperature_sensor_stat() .
* if the upper layer has informed the link layer by the existence of temperature sensor through @ref ll_intf_set_temperature_sensor_stat() or llhwc_cmn_set_temperature_sensor_stat() .
* New temperature will be requested in the following cases:
* 1- at initialization when the @ref ll_intf_set_temperature_sensor_state or llhwc_cmn_set_temperature_sensor_stat is called
* 2- before any radio event
Expand Down
1 change: 0 additions & 1 deletion lib/stm32wba/hci/ll/event_manager.h
Original file line number Diff line number Diff line change
Expand Up @@ -349,4 +349,3 @@ uint8_t emngr_process_conditional_event( uint8_t id, uint8_t only_one_event,
*/

#endif /* INCLUDE_EVENT_MANAGER_H_ */

2 changes: 0 additions & 2 deletions lib/stm32wba/hci/ll/evnt_schdlr_gnrc_if.h
Original file line number Diff line number Diff line change
Expand Up @@ -205,5 +205,3 @@ uint8_t evnt_schdlr_confrm_grant(void * evnt_hndl);
/**
* @}
*/


3 changes: 0 additions & 3 deletions lib/stm32wba/hci/ll/hci.h
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,3 @@ void hci_ll_set_custom_event_mask(uint8_t cstm_evnt_mask);
#endif /* SUPPORT_HCI_EVENT_ONLY */

#endif /* INCLUDE_HCI_H */



Loading

0 comments on commit bb66261

Please sign in to comment.