summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorhierophect <hierophect@gmail.com>2020-08-27 11:00:29 -0400
committerGitHub <noreply@github.com>2020-08-27 11:00:29 -0400
commit772052598d1cf6b5b631341f25bf2b60edf5bc55 (patch)
tree85550e8ccc9b8dd4090e4e55342abf9f23b05586 /docs
parent8d2299e61e482f0edbf9f58bd20043761a30492a (diff)
parentfe73cfb922f37ac7b0af19bccaced8e70a808b3c (diff)
Merge branch 'main' into stm32-meowbit-fix
Diffstat (limited to 'docs')
-rw-r--r--docs/porting.rst43
1 files changed, 30 insertions, 13 deletions
diff --git a/docs/porting.rst b/docs/porting.rst
index db4ae7626..6cd59fefb 100644
--- a/docs/porting.rst
+++ b/docs/porting.rst
@@ -51,10 +51,15 @@ as a natural "TODO" list. An example minimal build list is shown below:
.. code-block:: makefile
# These modules are implemented in ports/<port>/common-hal:
- CIRCUITPY_MICROCONTROLLER = 0 # Typically the first module to create
- CIRCUITPY_DIGITALIO = 0 # Typically the second module to create
+
+ # Typically the first module to create
+ CIRCUITPY_MICROCONTROLLER = 0
+ # Typically the second module to create
+ CIRCUITPY_DIGITALIO = 0
+ # Other modules:
CIRCUITPY_ANALOGIO = 0
CIRCUITPY_BUSIO = 0
+ CIRCUITPY_COUNTIO = 0
CIRCUITPY_NEOPIXEL_WRITE = 0
CIRCUITPY_PULSEIO = 0
CIRCUITPY_OS = 0
@@ -63,22 +68,34 @@ as a natural "TODO" list. An example minimal build list is shown below:
CIRCUITPY_AUDIOIO = 0
CIRCUITPY_ROTARYIO = 0
CIRCUITPY_RTC = 0
+ CIRCUITPY_SDCARDIO = 0
+ CIRCUITPY_FRAMEBUFFERIO = 0
CIRCUITPY_FREQUENCYIO = 0
CIRCUITPY_I2CPERIPHERAL = 0
- CIRCUITPY_DISPLAYIO = 0 # Requires SPI, PulseIO (stub ok)
+ # Requires SPI, PulseIO (stub ok):
+ CIRCUITPY_DISPLAYIO = 0
# These modules are implemented in shared-module/ - they can be included in
# any port once their prerequisites in common-hal are complete.
- CIRCUITPY_BITBANGIO = 0 # Requires DigitalIO
- CIRCUITPY_GAMEPAD = 0 # Requires DigitalIO
- CIRCUITPY_PIXELBUF = 0 # Requires neopixel_write or SPI (dotstar)
- CIRCUITPY_RANDOM = 0 # Requires OS
- CIRCUITPY_STORAGE = 0 # Requires OS, filesystem
- CIRCUITPY_TOUCHIO = 0 # Requires Microcontroller
- CIRCUITPY_USB_HID = 0 # Requires USB
- CIRCUITPY_USB_MIDI = 0 # Requires USB
- CIRCUITPY_REQUIRE_I2C_PULLUPS = 0 # Does nothing without I2C
- CIRCUITPY_ULAB = 0 # No requirements, but takes extra flash
+ # Requires DigitalIO:
+ CIRCUITPY_BITBANGIO = 0
+ # Requires DigitalIO
+ CIRCUITPY_GAMEPAD = 0
+ # Requires neopixel_write or SPI (dotstar)
+ CIRCUITPY_PIXELBUF = 0
+ # Requires OS
+ CIRCUITPY_RANDOM = 0
+ # Requires OS, filesystem
+ CIRCUITPY_STORAGE = 0
+ # Requires Microcontroller
+ CIRCUITPY_TOUCHIO = 0
+ # Requires USB
+ CIRCUITPY_USB_HID = 0
+ CIRCUITPY_USB_MIDI = 0
+ # Does nothing without I2C
+ CIRCUITPY_REQUIRE_I2C_PULLUPS = 0
+ # No requirements, but takes extra flash
+ CIRCUITPY_ULAB = 0
Step 2: Init
--------------