djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
f84145bea1
circuitpython/ports/esp8266/modmachine.h

40 lines
1.1 KiB
C
Raw Normal View History

all: Unify header guard usage. 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
2017-06-29 17:14:58 -04:00
#ifndef MICROPY_INCLUDED_ESP8266_MODMACHINE_H
#define MICROPY_INCLUDED_ESP8266_MODMACHINE_H
esp8266: Protect modpyb.h header file from multiple inclusions. Also include py/obj.h so the header is self contained.
2016-04-12 08:53:04 -04:00
#include "py/obj.h"
esp8266: Add basic pyb.Pin class; supports output mode only.
2015-02-13 17:21:44 -05:00
extern const mp_obj_type_t pyb_pin_type;
esp8266: Add PWM support. PWM implementation uses a timer and interrupts (FRC1), taken from Espressif's/NodeMCU's implementation and adapted for our use. 8 channels are supported, on pins 0, 2, 4, 5, 12, 13, 14, 15. Usage: import machine pwm0 = machine.PWM(machine.Pin(0)) pwm0.freq(1000) pwm0.duty(500) Frequency is shared (ie the same) for all channels. Frequency is between 1 and 1000. Duty is between 0 and 1023.
2016-03-02 08:37:27 -05:00
extern const mp_obj_type_t pyb_pwm_type;
esp8266/machine_adc: Rename pyb_adc_* to machine_adc_*.
2019-07-19 22:41:20 -04:00
extern const mp_obj_type_t machine_adc_type;
esp8266: Make pyb.RTC a type, and pyb.RTC() constructs an RTC object. This is the standard way of doing things, one should construct a peripheral object (even if it's a singleton). See issue #1330.
2015-06-22 18:03:17 -04:00
extern const mp_obj_type_t pyb_rtc_type;
esp8266: Add initial implementation of machine.UART. Currently UART(0) and UART(1) are exposed and only uart.write works.
2016-04-06 12:45:52 -04:00
extern const mp_obj_type_t pyb_uart_type;
esp8266: Add basic I2C driver, with init and writeto methods. Tested and working with SSD1306 I2C display.
2016-02-11 07:43:41 -05:00
extern const mp_obj_type_t pyb_i2c_type;
esp8266: Refactor to use extmod implementation of software SPI class.
2016-12-07 22:41:58 -05:00
extern const mp_obj_type_t machine_hspi_type;
esp8266: Expose simple pin API at C level.
2015-12-28 19:19:23 -05:00
py: Be more specific with MP_DECLARE_CONST_FUN_OBJ macros. In order to have more fine-grained control over how builtin functions are constructed, the MP_DECLARE_CONST_FUN_OBJ macros are made more specific, with suffix of _0, _1, _2, _3, _VAR, _VAR_BETEEN or _KW. These names now match the MP_DEFINE_CONST_FUN_OBJ macros.
2016-10-17 20:06:20 -04:00
MP_DECLARE_CONST_FUN_OBJ_VAR_BETWEEN(pyb_info_obj);
esp8266: Move pyb.info() function to esp module and remove pyb module. All functionality of the pyb module is available in other modules, like time, machine and os. The only outstanding function, info(), is (temporarily) moved to the esp module and the pyb module is removed.
2016-04-28 07:23:55 -04:00
esp8266: Expose pin object as a public structure for use as C pin API. This is an initial attempt at making a simple C pin API for writing things like I2C drivers in C.
2016-02-11 06:41:58 -05:00
typedef struct _pyb_pin_obj_t {
mp_obj_base_t base;
uint16_t phys_port;
uint16_t func;
esp8266: Remove pin_id field from C pin object. This field is the same as phys_port and not needed.
2016-04-13 17:38:44 -04:00
uint32_t periph;
esp8266: Expose pin object as a public structure for use as C pin API. This is an initial attempt at making a simple C pin API for writing things like I2C drivers in C.
2016-02-11 06:41:58 -05:00
} pyb_pin_obj_t;
esp8266: Convert mp_hal_pin_obj_t from pin ptr to simple integer. Most pin I/O can be done just knowing the pin number as a simple integer, and it's more efficient this way (code size, speed) because it doesn't require a memory lookup to get the pin id from the pin object. If the full pin object is needed then it can be easily looked up in the pin table.
2016-04-22 05:04:12 -04:00
const pyb_pin_obj_t pyb_pin_obj[16 + 1];
esp8266: Add hard IRQ callbacks for pin change on GPIO0-15.
2016-04-14 06:15:43 -04:00
void pin_init0(void);
esp8266: Expose simple pin API at C level.
2015-12-28 19:19:23 -05:00
uint mp_obj_get_pin(mp_obj_t pin_in);
esp8266: Expose pin object as a public structure for use as C pin API. This is an initial attempt at making a simple C pin API for writing things like I2C drivers in C.
2016-02-11 06:41:58 -05:00
pyb_pin_obj_t *mp_obj_get_pin_obj(mp_obj_t pin_in);
esp8266: Expose simple pin API at C level.
2015-12-28 19:19:23 -05:00
int pin_get(uint pin);
void pin_set(uint pin, int value);
esp8266: Protect modpyb.h header file from multiple inclusions. Also include py/obj.h so the header is self contained.
2016-04-12 08:53:04 -04:00
esp8266: Rename "machine" module implementation to use contemporary naming. Previously they used historical "pyb" affix causing confusion and inconsistency (there's no "pyb" module in modern ports; but people took esp8266 port as an example, and "pyb" naming kept proliferating, while other people complained that source structure is not clear).
2016-11-05 18:30:19 -04:00
extern uint32_t pyb_rtc_alarm0_wake;
extern uint64_t pyb_rtc_alarm0_expiry;
void pyb_rtc_set_us_since_2000(uint64_t nowus);
uint64_t pyb_rtc_get_us_since_2000();
void rtc_prepare_deepsleep(uint64_t sleep_us);
all: Unify header guard usage. 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
2017-06-29 17:14:58 -04:00
#endif // MICROPY_INCLUDED_ESP8266_MODMACHINE_H
Reference in New Issue Copy Permalink