circuitpython/drivers
Alexander Steffen 299bc62586 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-07-18 11:57:39 +10:00
..
cc3000 py: Specialise builtin funcs to use separate type for fixed arg count. 2016-10-21 16:26:01 +11:00
cc3100 drivers: Update CC3100 driver library to SDK release version 1.1.0. 2015-03-16 00:42:08 +01:00
dht all: Unify header guard usage. 2017-07-18 11:57:39 +10:00
display drivers: Replace deprecated Pin.high()/low() methods with .__call__(1/0). 2017-05-21 17:44:58 +03:00
memory all: Unify header guard usage. 2017-07-18 11:57:39 +10:00
nrf24l01 drivers: Replace deprecated Pin.high()/low() methods with .__call__(1/0). 2017-05-21 17:44:58 +03:00
onewire drivers/onewire: Enable pull-up when init'ing the 1-wire pin. 2017-06-26 17:48:05 +10:00
sdcard drivers: Replace deprecated Pin.high()/low() methods with .__call__(1/0). 2017-05-21 17:44:58 +03:00
wiznet5k drivers/wiznet5k: Fix indentation so it's not misleading. 2016-07-11 21:11:25 +01:00
README.md Added 'drivers' directory, intended to hold code for specific hardware. 2014-09-01 22:52:37 +01:00

README.md

This directory contains drivers for specific hardware. The drivers are intended to work across multiple ports.