ral_fsm.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. /**
  2. * Copyright (c) 2016 - 2020 Nordic Semiconductor ASA and Luxoft Global Operations Gmbh.
  3. *
  4. * All Rights Reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. *
  10. * 1. Redistributions of source code must retain the above copyright notice, this
  11. * list of conditions and the following disclaimer.
  12. *
  13. * 2. Redistributions in binary form, except as embedded into a Nordic
  14. * Semiconductor ASA integrated circuit in a product or a software update for
  15. * such product, must reproduce the above copyright notice, this list of
  16. * conditions and the following disclaimer in the documentation and/or other
  17. * materials provided with the distribution.
  18. *
  19. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  20. * contributors may be used to endorse or promote products derived from this
  21. * software without specific prior written permission.
  22. *
  23. * 4. This software, with or without modification, must only be used with a
  24. * Nordic Semiconductor ASA integrated circuit.
  25. *
  26. * 5. Any software provided in binary form under this license must not be reverse
  27. * engineered, decompiled, modified and/or disassembled.
  28. *
  29. *
  30. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  31. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  32. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  33. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  34. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  35. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  36. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  37. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  38. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  39. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  40. *
  41. */
  42. #ifndef RAL_FSM_H_INCLUDED
  43. #define RAL_FSM_H_INCLUDED
  44. #include "sys_fsm.h"
  45. /**
  46. * @defgroup ral_api_fsm RAL FSM API
  47. * @ingroup ral_api
  48. * @{
  49. */
  50. // list of possible events
  51. typedef enum
  52. {
  53. E_RESET,
  54. E_TRX_END, /**< Radio signals that TX or RX is complete.*/
  55. E_TX_REQ, /**< Initiates upload of a frame into radio memory and
  56. transmission of it into air.*/
  57. E_TRX_OFF,
  58. E_TX_ON,
  59. E_FORCE_TX_ON,
  60. E_RX_ON,
  61. } ral_fsm_events_t;
  62. // states
  63. typedef enum
  64. {
  65. /* State symbol for short FSM debug mode */
  66. /* I */ S_TRX_OFF,
  67. /* J */ S_TX_ON,
  68. /* */ S_BUSY_TX,
  69. /* G */ S_RX_ON,
  70. /* B */ S_BUSY_RX,
  71. } ral_fsm_states_t;
  72. /**@brief Reads current state of RAL state machine.
  73. *
  74. * @return Current state.
  75. */
  76. ral_fsm_states_t ral_fsm_current_state_get(void);
  77. /**@brief Initializes finite state machine of radio chip.*/
  78. void ral_fsm_init(void);
  79. /**@brief Sends new event to radio FSM. This function is used for
  80. * changing radio state.
  81. *
  82. * @param event - event id for FSM.
  83. * @param p_data - pointer to event specific data (expects pointer to ral_mem_t).
  84. */
  85. void ral_fsm_event_post(ral_fsm_events_t event, void * p_data);
  86. /** @} */
  87. #endif /* RAL_FSM_H_INCLUDED */