STM32Cube_FW_WB_V1.4.0 - STM32_WPAN part

Author: jeromecoutant

targets/TARGET_STM/TARGET_STM32WB/STM32Cube_FW/STM32_WPAN/hw.h

@@ -4,7 +4,7 @@
   * @author  MCD Application Team
   * @brief   Hardware
   ******************************************************************************
-  * @attention
+   * @attention
   *
   * <h2><center>&copy; Copyright (c) 2019 STMicroelectronics.
   * All rights reserved.</center></h2>
@@ -15,7 +15,7 @@
   *                        opensource.org/licenses/BSD-3-Clause
   *
   ******************************************************************************
-  */
+ */
 
 
 /* Define to prevent recursive inclusion -------------------------------------*/
@@ -27,240 +27,6 @@ extern "C" {
 #endif
 
   /* Includes ------------------------------------------------------------------*/
-#include "stm32wbxx.h"
-#include "stm32wbxx_ll_exti.h"
-#include "stm32wbxx_ll_system.h"
-#include "stm32wbxx_ll_rcc.h"
-#include "stm32wbxx_ll_ipcc.h"
-#include "stm32wbxx_ll_bus.h"
-#include "stm32wbxx_ll_pwr.h"
-#include "stm32wbxx_ll_cortex.h"
-#include "stm32wbxx_ll_utils.h"
-#include "stm32wbxx_ll_hsem.h"
-
-
-#ifdef  USE_STM32WBXX_USB_DONGLE
-#include "stm32wbxx_usb_dongle.h"
-#endif
-#ifdef  USE_STM32WBXX_NUCLEO
-#include "stm32wbxx_nucleo.h"
-#endif
-#ifdef  USE_X_NUCLEO_EPD
-#include "x_nucleo_epd.h"
-#endif
-
-  /******************************************************************************
-   * HW LOW POWER
-   ******************************************************************************/
-  /**
-   * Stop Mode configuration
-   * The values of enum shall be kept unchanged
-   */
-  typedef enum
-  {
-    hw_lpm_stopmode0,
-    hw_lpm_stopmode1,
-    hw_lpm_stopmode2,
-  } HW_LPM_StopModeConf_t;
-
-  /**
-   * Off Mode configuration
-   * The values of enum shall be kept unchanged
-   */
-  typedef enum
-  {
-    hw_lpm_standby,
-    hw_lpm_shutdown,
-  } HW_LPM_OffModeConf_t;
-
-  void HW_LPM_SleepMode(void);
-  void HW_LPM_StopMode(HW_LPM_StopModeConf_t configuration);
-  void HW_LPM_OffMode(HW_LPM_OffModeConf_t configuration);
-
-  /******************************************************************************
-   * HW UART
-   ******************************************************************************/
-  typedef enum
-  {
-    hw_uart1,
-    hw_uart2,
-    hw_lpuart1,
-  } hw_uart_id_t;
-
-  typedef enum
-  {
-    hw_uart_ok,
-    hw_uart_error,
-    hw_uart_busy,
-    hw_uart_to,
-  } hw_status_t;
-
-  void HW_UART_Init(hw_uart_id_t hw_uart_id);
-  void HW_UART_Receive_IT(hw_uart_id_t hw_uart_id, uint8_t *pData, uint16_t Size, void (*Callback)(void));
-  void HW_UART_Transmit_IT(hw_uart_id_t hw_uart_id, uint8_t *pData, uint16_t Size,  void (*Callback)(void));
-  hw_status_t HW_UART_Transmit(hw_uart_id_t hw_uart_id, uint8_t *p_data, uint16_t size,  uint32_t timeout);
-  hw_status_t HW_UART_Transmit_DMA(hw_uart_id_t hw_uart_id, uint8_t *p_data, uint16_t size, void (*Callback)(void));
-  void HW_UART_Interrupt_Handler(hw_uart_id_t hw_uart_id);
-  void HW_UART_DMA_Interrupt_Handler(hw_uart_id_t hw_uart_id);
-
-  /******************************************************************************
-   * HW TimerServer
-   ******************************************************************************/
-  /* Exported types ------------------------------------------------------------*/
-  /**
-   * This setting is used when standby mode is supported.
-   * hw_ts_InitMode_Limited should be used when the device restarts from Standby Mode. In that case, the Timer Server does
-   * not re-initialized its context. Only the Hardware register which content has been lost is reconfigured
-   * Otherwise, hw_ts_InitMode_Full should be requested (Start from Power ON) and everything is re-initialized.
-   */
-  typedef enum
-  {
-    hw_ts_InitMode_Full,
-    hw_ts_InitMode_Limited,
-  } HW_TS_InitMode_t;
-
-  /**
-   * When a Timer is created as a SingleShot timer, it is not automatically restarted when the timeout occurs. However,
-   * the timer is kept reserved in the list and could be restarted at anytime with HW_TS_Start()
-   *
-   * When a Timer is created as a Repeated timer, it is automatically restarted when the timeout occurs.
-   */
-  typedef enum
-  {
-    hw_ts_SingleShot,
-    hw_ts_Repeated
-  } HW_TS_Mode_t;
-
-  /**
-   * hw_ts_Successful is returned when a Timer has been successfully created with HW_TS_Create(). Otherwise, hw_ts_Failed
-   * is returned. When hw_ts_Failed is returned, that means there are not enough free slots in the list to create a
-   * Timer. In that case, CFG_HW_TS_MAX_NBR_CONCURRENT_TIMER should be increased
-   */
-  typedef enum
-  {
-    hw_ts_Successful,
-    hw_ts_Failed,
-  }HW_TS_ReturnStatus_t;
-
-  typedef void (*HW_TS_pTimerCb_t)(void);
-
-  /**
-   * @brief  Initialize the timer server
-   *         This API shall be called by the application before any timer is requested to the timer server. It
-   *         configures the RTC module to be connected to the LSI input clock.
-   *
-   * @param  TimerInitMode: When the device restarts from Standby, it should request hw_ts_InitMode_Limited so that the
-   *         Timer context is not re-initialized. Otherwise, hw_ts_InitMode_Full should be requested
-   * @param  hrtc: RTC Handle
-   * @retval None
-   */
-  void HW_TS_Init(HW_TS_InitMode_t TimerInitMode, RTC_HandleTypeDef *hrtc);
-
-  /**
-   * @brief  Interface to create a virtual timer
-   *         The user shall call this API to create a timer. Once created, the timer is reserved to the module until it
-   *         has been deleted. When creating a timer, the user shall specify the mode (single shot or repeated), the
-   *         callback to be notified when the timer expires and a module ID to identify in the timer interrupt handler
-   *         which module is concerned. In return, the user gets a timer ID to handle it.
-   *
-   * @param  TimerProcessID:  This is an identifier provided by the user and returned in the callback to allow
-   *                          identification of the requester
-   * @param  pTimerId: Timer Id returned to the user to request operation (start, stop, delete)
-   * @param  TimerMode: Mode of the virtual timer (Single shot or repeated)
-   * @param  pTimerCallBack: Callback when the virtual timer expires
-   * @retval HW_TS_ReturnStatus_t: Return whether the creation is sucessfull or not
-   */
-  HW_TS_ReturnStatus_t HW_TS_Create(uint32_t TimerProcessID, uint8_t *pTimerId, HW_TS_Mode_t TimerMode, HW_TS_pTimerCb_t pTimerCallBack);
-
-  /**
-   * @brief  Stop a virtual timer
-   *         This API may be used to stop a running timer. A timer which is stopped is move to the pending state.
-   *         A pending timer may be restarted at any time with a different timeout value but the mode cannot be changed.
-   *         Nothing is done when it is called to stop a timer which has been already stopped
-   *
-   * @param  TimerID:  Id of the timer to stop
-   * @retval None
-   */
-  void HW_TS_Stop(uint8_t TimerID);
-
-  /**
-   * @brief  Start a virtual timer
-   *         This API shall be used to start a timer. The timeout value is specified and may be different each time.
-   *         When the timer is in the single shot mode, it will move to the pending state when it expires. The user may
-   *         restart it at any time with a different timeout value. When the timer is in the repeated mode, it always
-   *         stay in the running state. When the timer expires, it will be restarted with the same timeout value.
-   *         This API shall not be called on a running timer.
-   *
-   * @param  TimerID:  The ID Id of the timer to start
-   * @param  timeout_ticks: Number of ticks of the virtual timer (Maximum value is (0xFFFFFFFF-0xFFFF = 0xFFFF0000)
-   * @retval None
-   */
-  void HW_TS_Start(uint8_t TimerID, uint32_t timeout_ticks);
-
-  /**
-   * @brief  Delete a virtual timer from the list
-   *         This API should be used when a timer is not needed anymore by the user. A deleted timer is removed from
-   *         the timer list managed by the timer server. It cannot be restarted again. The user has to go with the
-   *         creation of a new timer if required and may get a different timer id
-   *
-   * @param  TimerID:  The ID of the timer to remove from the list
-   * @retval None
-   */
-  void HW_TS_Delete(uint8_t TimerID);
-
-  /**
-   * @brief  Schedule the timer list on the timer interrupt handler
-   *         This interrupt handler shall be called by the application in the RTC interrupt handler. This handler takes
-   *         care of clearing all status flag required in the RTC and EXTI peripherals
-   *
-   * @param  None
-   * @retval None
-   */
-  void HW_TS_RTC_Wakeup_Handler(void);
-
-  /**
-   * @brief  Return the number of ticks to count before the interrupt
-   *         This API returns the number of ticks left to be counted before an interrupt is generated by the
-   *         Timer Server. This API may be used by the application for power management optimization. When the system
-   *         enters low power mode, the mode selection is a tradeoff between the wakeup time where the CPU is running
-   *         and the time while the CPU will be kept in low power mode before next wakeup. The deeper is the
-   *         low power mode used, the longer is the wakeup time. The low power mode management considering wakeup time
-   *         versus time in low power mode is implementation specific
-   *         When the timer is disabled (No timer in the list), it returns 0xFFFF
-   *
-   * @param  None
-   * @retval The number of ticks left to count
-   */
-  uint16_t HW_TS_RTC_ReadLeftTicksToCount(void);
-
-  /**
-   * @brief  Notify the application that a registered timer has expired
-   *         This API shall be implemented by the user application.
-   *         This API notifies the application that a timer expires. This API is running in the RTC Wakeup interrupt
-   *         context. The application may implement an Operating System to change the context priority where the timer
-   *         callback may be handled. This API provides the module ID to identify which module is concerned and to allow
-   *         sending the information to the correct task
-   *
-   * @param  TimerProcessID: The TimerProcessId associated with the timer when it has been created
-   * @param  TimerID: The TimerID of the expired timer
-   * @param  pTimerCallBack: The Callback associated with the timer when it has been created
-   * @retval None
-   */
-  void HW_TS_RTC_Int_AppNot(uint32_t TimerProcessID, uint8_t TimerID, HW_TS_pTimerCb_t pTimerCallBack);
-
-  /**
-   * @brief  Notify the application that the wakeupcounter has been updated
-   *         This API should be implemented by the user application
-   *         This API notifies the application that the counter has been updated. This is expected to be used along
-   *         with the HW_TS_RTC_ReadLeftTicksToCount () API. It could be that the counter has been updated since the
-   *         last call of HW_TS_RTC_ReadLeftTicksToCount () and before entering low power mode. This notification
-   *         provides a way to the application to solve that race condition to reevaluate the counter value before
-   *         entering low power mode
-   *
-   * @param  None
-   * @retval None
-   */
-  void HW_TS_RTC_CountUpdated_AppNot(void);
 
   /******************************************************************************
    * HW IPCC
@@ -292,6 +58,13 @@ extern "C" {
   void HW_IPCC_THREAD_CliSendAck( void );
   void HW_IPCC_THREAD_CliEvtNot( void );
 
+  void HW_IPCC_LLDTESTS_Init( void );
+  void HW_IPCC_LLDTESTS_SendCliCmd( void );
+  void HW_IPCC_LLDTESTS_ReceiveCliRsp( void );
+  void HW_IPCC_LLDTESTS_SendCliRspAck( void );
+  void HW_IPCC_LLDTESTS_ReceiveM0Cmd( void );
+  void HW_IPCC_LLDTESTS_SendM0CmdAck( void );
+
   void HW_IPCC_TRACES_Init( void );
   void HW_IPCC_TRACES_EvtNot( void );
 
@@ -301,6 +74,17 @@ extern "C" {
   void HW_IPCC_MAC_802_15_4_CmdEvtNot( void );
   void HW_IPCC_MAC_802_15_4_EvtNot( void );
 
+  void HW_IPCC_ZIGBEE_Init( void );
+
+  void HW_IPCC_ZIGBEE_SendAppliCmd(void);
+  void HW_IPCC_ZIGBEE_AppliCmdNotification(void);
+
+  void HW_IPCC_ZIGBEE_AppliAsyncEvtNotification(void);
+  void HW_IPCC_ZIGBEE_SendAppliCmdAck(void);
+  void HW_IPCC_ZIGBEE_AppliAsyncLoggingNotification( void );
+  void HW_IPCC_ZIGBEE_SendLoggingAck(void);
+
+
 #ifdef __cplusplus
 }
 #endif