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
29#include <stdint.h>
30#include "py/mpconfig.h"
31
32#ifdef MICROPY_MPHALPORT_H
33#include MICROPY_MPHALPORT_H
34#else
35#include <mphalport.h>
36#endif
37
38#ifndef mp_hal_stdio_poll
39uintptr_t mp_hal_stdio_poll(uintptr_t poll_flags);
40#endif
41
42#ifndef mp_hal_stdin_rx_chr
43int mp_hal_stdin_rx_chr(void);
44#endif
45
46#ifndef mp_hal_stdout_tx_str
47void mp_hal_stdout_tx_str(const char *str);
48#endif
49
50#ifndef mp_hal_stdout_tx_strn
51void mp_hal_stdout_tx_strn(const char *str, size_t len);
52#endif
53
54#ifndef mp_hal_stdout_tx_strn_cooked
55void mp_hal_stdout_tx_strn_cooked(const char *str, size_t len);
56#endif
57
58#ifndef mp_hal_delay_ms
59void mp_hal_delay_ms(mp_uint_t ms);
60#endif
61
62#ifndef mp_hal_delay_us
63void mp_hal_delay_us(mp_uint_t us);
64#endif
65
66#ifndef mp_hal_ticks_ms
67mp_uint_t mp_hal_ticks_ms(void);
68#endif
69
70#ifndef mp_hal_ticks_us
71mp_uint_t mp_hal_ticks_us(void);
72#endif
73
74#ifndef mp_hal_ticks_cpu
75mp_uint_t mp_hal_ticks_cpu(void);
76#endif
77
78#ifndef mp_hal_time_ns
79// Nanoseconds since the Epoch.
80uint64_t mp_hal_time_ns(void);
81#endif
82
83// If port HAL didn't define its own pin API, use generic
84// "virtual pin" API from the core.
85#ifndef mp_hal_pin_obj_t
86#define mp_hal_pin_obj_t mp_obj_t
87#define mp_hal_get_pin_obj(pin) (pin)
88#define mp_hal_pin_read(pin) mp_virtual_pin_read(pin)
89#define mp_hal_pin_write(pin, v) mp_virtual_pin_write(pin, v)
90#include "extmod/virtpin.h"
91#endif
92
93#endif // MICROPY_INCLUDED_PY_MPHAL_H
94