mphal.h 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. /*
  2. * This file is part of the MicroPython project, http://micropython.org/
  3. *
  4. * The MIT License (MIT)
  5. *
  6. * Copyright (c) 2015 Damien P. George
  7. *
  8. * Permission is hereby granted, free of charge, to any person obtaining a copy
  9. * of this software and associated documentation files (the "Software"), to deal
  10. * in the Software without restriction, including without limitation the rights
  11. * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  12. * copies of the Software, and to permit persons to whom the Software is
  13. * furnished to do so, subject to the following conditions:
  14. *
  15. * The above copyright notice and this permission notice shall be included in
  16. * all copies or substantial portions of the Software.
  17. *
  18. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  21. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  22. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  23. * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  24. * THE SOFTWARE.
  25. */
  26. #ifndef MICROPY_INCLUDED_PY_MPHAL_H
  27. #define MICROPY_INCLUDED_PY_MPHAL_H
  28. #include <stdint.h>
  29. #include "py/mpconfig.h"
  30. #ifdef MICROPY_MPHALPORT_H
  31. #include MICROPY_MPHALPORT_H
  32. #else
  33. #include <mphalport.h>
  34. #endif
  35. // On embedded platforms, these will typically enable/disable irqs.
  36. #ifndef MICROPY_BEGIN_ATOMIC_SECTION
  37. #define MICROPY_BEGIN_ATOMIC_SECTION() (0)
  38. #endif
  39. #ifndef MICROPY_END_ATOMIC_SECTION
  40. #define MICROPY_END_ATOMIC_SECTION(state) (void)(state)
  41. #endif
  42. #ifndef mp_hal_stdio_poll
  43. uintptr_t mp_hal_stdio_poll(uintptr_t poll_flags);
  44. #endif
  45. #ifndef mp_hal_stdin_rx_chr
  46. int mp_hal_stdin_rx_chr(void);
  47. #endif
  48. #ifndef mp_hal_stdout_tx_str
  49. void mp_hal_stdout_tx_str(const char *str);
  50. #endif
  51. #ifndef mp_hal_stdout_tx_strn
  52. mp_uint_t mp_hal_stdout_tx_strn(const char *str, size_t len);
  53. #endif
  54. #ifndef mp_hal_stdout_tx_strn_cooked
  55. void mp_hal_stdout_tx_strn_cooked(const char *str, size_t len);
  56. #endif
  57. #ifndef mp_hal_delay_ms
  58. void mp_hal_delay_ms(mp_uint_t ms);
  59. #endif
  60. #ifndef mp_hal_delay_us
  61. void mp_hal_delay_us(mp_uint_t us);
  62. #endif
  63. #ifndef mp_hal_ticks_ms
  64. mp_uint_t mp_hal_ticks_ms(void);
  65. #endif
  66. #ifndef mp_hal_ticks_us
  67. mp_uint_t mp_hal_ticks_us(void);
  68. #endif
  69. #ifndef mp_hal_ticks_cpu
  70. mp_uint_t mp_hal_ticks_cpu(void);
  71. #endif
  72. #ifndef mp_hal_time_ns
  73. // Nanoseconds since the Epoch.
  74. uint64_t mp_hal_time_ns(void);
  75. #endif
  76. // If port HAL didn't define its own pin API, use generic
  77. // "virtual pin" API from the core.
  78. #ifndef mp_hal_pin_obj_t
  79. #define mp_hal_pin_obj_t mp_obj_t
  80. #define mp_hal_get_pin_obj(pin) (pin)
  81. #define mp_hal_pin_read(pin) mp_virtual_pin_read(pin)
  82. #define mp_hal_pin_write(pin, v) mp_virtual_pin_write(pin, v)
  83. #include "extmod/virtpin.h"
  84. #endif
  85. // Event handling and wait-for-event functions.
  86. #ifndef MICROPY_INTERNAL_WFE
  87. // Fallback definition for ports that don't need to suspend the CPU.
  88. #define MICROPY_INTERNAL_WFE(TIMEOUT_MS) (void)0
  89. #endif
  90. #ifndef MICROPY_INTERNAL_EVENT_HOOK
  91. // Fallback definition for ports that don't need any port-specific
  92. // non-blocking event processing.
  93. #define MICROPY_INTERNAL_EVENT_HOOK (void)0
  94. #endif
  95. #endif // MICROPY_INCLUDED_PY_MPHAL_H