hal_uart_task_scheduler.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  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 HAL_UART_TASK_SCHEDULER_H_INCLUDED
  43. #define HAL_UART_TASK_SCHEDULER_H_INCLUDED
  44. #include <stdint.h>
  45. #include "hal_atomic.h"
  46. #include "hal_task_scheduler.h"
  47. #include "sys_utils.h"
  48. /**
  49. * @defgroup hal_uart_task_scheduler HAL UART Task Scheduler
  50. * @ingroup hal_15_4
  51. * @{
  52. * @brief Module to declare HAL UART Task Scheduler interface
  53. */
  54. /**@brief Identifiers for registered UART event handlers.
  55. *
  56. * @details enumeration with identifiers of registered UART event handlers.
  57. * UART handlers will be called from the HAL_UART task. */
  58. typedef enum
  59. {
  60. HAL_UART_RX_TASK_ID,
  61. HAL_UART_TX_TASK_ID,
  62. HAL_UART_ERROR_TASK_ID,
  63. HAL_UART_TASKS_AMOUNT,
  64. } hal_uart_task_id_t;
  65. /**@brief Prototype of a UART task handler.
  66. *
  67. * @details Handler which will be called from HAL_UART task. */
  68. typedef void (* hal_uart_task_handler_t)(uint32_t channel);
  69. void hal_uart_rx_handler(uint32_t channel);
  70. void hal_uart_tx_handler(uint32_t channel);
  71. void hal_uart_error_handler(uint32_t channel);
  72. /**@brief UART channels.
  73. *
  74. * @details Array which includes event id for every channel it happened. */
  75. extern volatile uint16_t g_hal_uart_modules_tasks[CONFIG_HAL_UART_CHANNELS];
  76. /**@brief Notifies HAL task scheduler to add an UART task for execution.
  77. *
  78. * @details The function sets a marker for the UART event task for execution.
  79. * And sets this marker for a channel where event happened.
  80. *
  81. * @param[in] channel event channel.
  82. * @param[in] hal_uart_task_id HAL task identificator. */
  83. static inline void hal_uart_task_post(uint32_t channel,
  84. uint8_t hal_uart_task_id)
  85. {
  86. atomic_t atomic = 0;
  87. hal_atomic_start(&atomic);
  88. g_hal_uart_modules_tasks[channel] |= BIT(hal_uart_task_id);
  89. hal_atomic_end(&atomic);
  90. hal_task_post(HAL_UART_TASK_ID);
  91. }
  92. /** @} */
  93. #endif /* HAL_UART_TASK_SCHEDULER_H_INCLUDED */