299bc62586
The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_*.h * qstrdefs*.h
96 lines
3.3 KiB
C
96 lines
3.3 KiB
C
/*
|
|
* This file is part of the Micro Python project, http://micropython.org/
|
|
*
|
|
* The MIT License (MIT)
|
|
*
|
|
* Copyright (c) 2014 Damien P. George
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*/
|
|
|
|
#include "py/ringbuf.h"
|
|
#include "lib/utils/interrupt_char.h"
|
|
#include "xtirq.h"
|
|
|
|
void mp_keyboard_interrupt(void);
|
|
|
|
struct _mp_print_t;
|
|
// Structure for UART-only output via mp_printf()
|
|
extern const struct _mp_print_t mp_debug_print;
|
|
|
|
extern ringbuf_t input_buf;
|
|
// Call this after putting data to input_buf
|
|
void mp_hal_signal_input(void);
|
|
// Call this when data is available in dupterm object
|
|
void mp_hal_signal_dupterm_input(void);
|
|
|
|
void mp_hal_init(void);
|
|
void mp_hal_rtc_init(void);
|
|
|
|
uint32_t mp_hal_ticks_us(void);
|
|
__attribute__((always_inline)) static inline uint32_t mp_hal_ticks_cpu(void) {
|
|
uint32_t ccount;
|
|
__asm__ __volatile__("rsr %0,ccount":"=a" (ccount));
|
|
return ccount;
|
|
}
|
|
|
|
void mp_hal_delay_us(uint32_t);
|
|
void mp_hal_set_interrupt_char(int c);
|
|
uint32_t mp_hal_get_cpu_freq(void);
|
|
|
|
#define UART_TASK_ID 0
|
|
#define DUPTERM_TASK_ID 1
|
|
void uart_task_init();
|
|
void dupterm_task_init();
|
|
|
|
void ets_event_poll(void);
|
|
#define ETS_POLL_WHILE(cond) { while (cond) ets_event_poll(); }
|
|
|
|
// needed for machine.I2C
|
|
#include "osapi.h"
|
|
#define mp_hal_delay_us_fast(us) os_delay_us(us)
|
|
|
|
#define mp_hal_quiet_timing_enter() disable_irq()
|
|
#define mp_hal_quiet_timing_exit(irq_state) enable_irq(irq_state)
|
|
|
|
// C-level pin HAL
|
|
#include "etshal.h"
|
|
#include "gpio.h"
|
|
#include "esp8266/modmachine.h"
|
|
#define MP_HAL_PIN_FMT "%u"
|
|
#define mp_hal_pin_obj_t uint32_t
|
|
#define mp_hal_get_pin_obj(o) mp_obj_get_pin(o)
|
|
#define mp_hal_pin_name(p) (p)
|
|
void mp_hal_pin_input(mp_hal_pin_obj_t pin);
|
|
void mp_hal_pin_output(mp_hal_pin_obj_t pin);
|
|
void mp_hal_pin_open_drain(mp_hal_pin_obj_t pin);
|
|
#define mp_hal_pin_od_low(p) do { \
|
|
if ((p) == 16) { WRITE_PERI_REG(RTC_GPIO_ENABLE, (READ_PERI_REG(RTC_GPIO_ENABLE) & ~1) | 1); } \
|
|
else { gpio_output_set(0, 1 << (p), 1 << (p), 0); } \
|
|
} while (0)
|
|
#define mp_hal_pin_od_high(p) do { \
|
|
if ((p) == 16) { WRITE_PERI_REG(RTC_GPIO_ENABLE, (READ_PERI_REG(RTC_GPIO_ENABLE) & ~1)); } \
|
|
else { gpio_output_set(1 << (p), 0, 1 << (p), 0); } \
|
|
} while (0)
|
|
#define mp_hal_pin_read(p) pin_get(p)
|
|
#define mp_hal_pin_write(p, v) pin_set((p), (v))
|
|
|
|
void *ets_get_esf_buf_ctlblk(void);
|
|
int ets_esf_free_bufs(int idx);
|