suspect-devices/circuitpython/py/mphal.h, branch 2.2.3CircuitPython - a Python implementation for teaching coding with microcontrollershttps://git.suspectdevices.com/suspect-devices/circuitpython/atom?h=2.2.32017-07-31T08:35:40+00:00all: Use the name MicroPython consistently in comments2017-07-31T08:35:40+00:00Alexander Steffendevel.20.webmeister@spamgourmet.com2017-06-30T07:22:17+00:00urn:sha1:55f33240f3d7051d4213629e92437a36f1fac50e
There were several different spellings of MicroPython present in comments,
when there should be only one.
all: Unify header guard usage.2017-07-18T01:57:39+00:00Alexander Steffendevel.20.webmeister@spamgourmet.com2017-06-29T21:14:58+00:00urn:sha1:299bc625864b9e624ed599c94a5f95870516139a
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
extmod/utime_mphal: Factor out implementations in terms of mp_hal_* for reuse.2016-10-14T17:14:01+00:00Paul Sokolovskypfalcon@users.sourceforge.net2016-10-14T17:13:02+00:00urn:sha1:a97284423eba9470c16c5f02fadea14bd8263751
As long as a port implement mp_hal_sleep_ms(), mp_hal_ticks_ms(), etc.
functions, it can just use standard implementations of utime.sleel_ms(),
utime.ticks_ms(), etc. Python-level functions.
py/mphal.h: If virtpin API is used, automagically include its header.2016-06-18T21:12:37+00:00Paul Sokolovskypfalcon@users.sourceforge.net2016-06-18T21:12:37+00:00urn:sha1:41167554e4d02f7f0e45099c5f6a41af01071559extmod/virtpin: Initial implementation of open-ended C-level Pin interface.2016-05-26T22:08:43+00:00Paul Sokolovskypfalcon@users.sourceforge.net2016-05-26T21:57:18+00:00urn:sha1:751e3b7a820c13561cca47717d47d7784f776232
Using usual method of virtual method tables. Single virtual method,
ioctl, is defined currently for all operations. This universal and
extensible vtable-based method is also defined as a default MPHAL
GPIO implementation, but a specific port may override it with its
own implementation (e.g. close-ended, but very efficient, e.g. avoiding
virtual method dispatch).
py/mphal.h: Provide default prototypes for mp_hal_delay_us/mp_hal_ticks_us.2016-05-20T23:13:50+00:00Paul Sokolovskypfalcon@users.sourceforge.net2016-05-20T23:12:11+00:00urn:sha1:5a2a4e9452ef5325b111879e10d636fd0954e289
Similar to existing mp_hal_delay_ms/mp_hal_ticks_ms.
all: Add py/mphal.h and use it in all ports.2015-10-31T16:14:30+00:00Damien Georgedamien.p.george@gmail.com2015-10-30T23:03:58+00:00urn:sha1:731f359292c0e2630873df1a19c5baac7287024f
py/mphal.h contains declarations for generic mp_hal_XXX functions, such
as stdio and delay/ticks, which ports should provide definitions for. A
port will also provide mphalport.h with further HAL declarations.