Go to file
Jeff Epler 5e26862b2c
Allow use of CONFIG_SPIRAM_USE_CAPS_ALLOC
.. and switch makerfabs tft7 over to it as a test.

We have our existing way of "reserving" PSRAM for esp-idf (we actually
control it all but add back the "reserved" part). However, this does
not work with off the shelf esp_lcd, which only will allocate a
framebuffer in PSRAM if CONFIG_SPIRAM_USE_CAPS_ALLOC (or CONFIG_SPIRAM_USE_ALLOC)
is defined, not if CONFIG_SPIRAM_USE_MEMMAP is.

This new way is possibly compatible with more esp-idf code, but it complicates
CircuitPython's initial startup since nothing until port_heap_init is
permitted to use the CP heap or supervisor allocator. In practice this
seems to be OK today.

Right now this doesn't change the setting across all boards with PSRAM and so
it does not revert esp-idf to its prior state. Instead, what I'm thinking is
that we can do it during or just after the IDF5 update when sdkconfig files
will be getting an overhaul anyway.
2023-09-05 12:43:22 -05:00
.codespell pre-commit fixes 2023-08-14 00:59:22 -04:00
.devcontainer fixed typo (path) in postCreateCommand 2022-12-16 09:13:34 +01:00
.github fix native tests 2023-08-22 12:57:47 -04:00
LICENSES Add an explicit SPDX license file for ter-u12n. 2020-07-06 19:15:41 +01:00
data Add new board uGame22 2023-08-25 19:26:30 +02:00
devices/ble_hci wip; fix more m_malloc and gc_alloc 2023-08-11 00:30:34 -04:00
docs Merge remote-tracking branch 'origin/8.2.x' into merge-82x 2023-08-22 08:49:16 -05:00
examples Make natmods work again. 2023-08-19 16:59:13 -05:00
extmod Fix gzip Decompression Support 2023-08-26 20:28:46 -07:00
frozen Add new board uGame22 2023-08-25 19:26:30 +02:00
lib Merge remote-tracking branch 'origin/8.2.x' into merge-82x 2023-08-22 08:49:16 -05:00
locale Add DotClockFramebuffer 2023-08-30 10:30:15 -05:00
logo Add license to some obvious files. 2020-07-06 19:16:25 +01:00
mpy-cross Fix `mpy-cross -X native` 2023-08-19 13:44:13 -05:00
ports Allow use of CONFIG_SPIRAM_USE_CAPS_ALLOC 2023-09-05 12:43:22 -05:00
py Add DotClockFramebuffer 2023-08-30 10:30:15 -05:00
shared pre-commit fixes 2023-08-14 00:59:22 -04:00
shared-bindings Add support for a non-displayed left portion of screen 2023-08-31 14:52:26 -05:00
shared-module Add DotClockFramebuffer 2023-08-30 10:30:15 -05:00
supervisor Allow use of CONFIG_SPIRAM_USE_CAPS_ALLOC 2023-09-05 12:43:22 -05:00
tests fix native tests 2023-08-22 12:57:47 -04:00
tools add a link to the faq about this 2023-08-30 10:54:43 -05:00
.codespellrc fix typos (partial) detected by codepell 2023-03-18 22:17:02 +07:00
.git-blame-ignore-revs top: Update .git-blame-ignore-revs for latest formatting commit. 2022-05-05 13:31:04 +10:00
.gitattributes Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
.gitignore Rename test function, make 'bad' files binary & add another test 2022-12-09 15:23:56 -06:00
.gitmodules Basic USB host support and keyboard workflow 2023-07-10 14:22:21 -07:00
.mailmap Add a `.mailmap` file to collate together multiple author entries. 2020-07-06 19:15:41 +01:00
.pre-commit-config.yaml remove certain excludes from pre-commit 2023-03-25 13:09:35 +05:30
.readthedocs.yml update `.readthedocs.yml` and add it to docs pattern 2023-03-11 11:56:04 +05:30
.rosie.yml Add license to some obvious files. 2020-07-06 19:16:25 +01:00
ACKNOWLEDGEMENTS Merge MicroPython 1.12 into CircuitPython 2021-05-03 14:01:18 -07:00
ACKNOWLEDGEMENTS.license Add license to some obvious files. 2020-07-06 19:16:25 +01:00
BUILDING.md fetch-port-submodules; fetch-all-submodules 2023-06-05 17:23:34 -04:00
CODE_OF_CONDUCT.md Fix up Contributor Covenant homepage link 2023-04-10 15:33:38 +12:00
CONTRIBUTING.md Fix error 2020-10-26 23:36:54 +01:00
LICENSE update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
LICENSE_MicroPython update formatting of LICENSE and clean-up 2022-08-27 14:47:10 +05:30
MANIFEST.in-stubs refine stubs-building procedure 2021-06-22 08:59:05 -05:00
Makefile fetch-port-submodules; fetch-all-submodules 2023-06-05 17:23:34 -04:00
README.rst Merge pull request #8344 from jepler/repl-py 2023-08-29 11:20:13 -07:00
README.rst-stubs Actually reduce the README text for the stubs package 2021-06-24 13:41:01 -05:00
WEBUSB_README.md Rename esp32s2 port to espressif 2021-09-13 16:44:55 -07:00
conf.py Merge remote-tracking branch 'origin/8.2.x' into merge-82x 2023-08-28 08:30:30 -05:00
main.c Allow use of CONFIG_SPIRAM_USE_CAPS_ALLOC 2023-09-05 12:43:22 -05:00
requirements-ci.txt only install `awscli` when required 2023-01-16 17:03:39 +05:30
requirements-dev.txt Silabs' new Pull Request for submoduling the ports/silabs/tools/slc_cli_linux/ (#7874) 2023-04-18 12:42:16 -04:00
requirements-doc.txt Updated how stubs are built 2023-05-09 22:01:24 -04:00
runtime.py Conditionalize LTO 2022-05-27 12:59:54 -07:00
setup.py-stubs use --long for describe in setup.py-stubs 2022-02-18 21:22:02 -05:00

README.rst-stubs

CircuitPython
=============

.. image:: https://s3.amazonaws.com/adafruit-circuit-python/CircuitPython_Repo_header_logo.png

|Build Status| |Doc Status| |License| |Discord| |Weblate|

`circuitpython.org <https://circuitpython.org>`__ \| `Get CircuitPython <#get-circuitpython>`__ \|
`Documentation <#documentation>`__ \| `Contributing <#contributing>`__ \|
`Branding <#branding>`__ \| `Differences from Micropython <#differences-from-micropython>`__ \|
`Project Structure <#project-structure>`__

**CircuitPython** is a *beginner friendly*, open source version of Python for tiny, inexpensive
computers called microcontrollers.

This package contains the "stubs", or type definitions for CircuitPython.  With some advanced
editors and other tools, this information can be identify TypeErrors, AttributeErrors, and other
problems before you deploy your code to a device and can even help autocomplete your code.

.. |Build Status| image:: https://github.com/adafruit/circuitpython/workflows/Build%20CI/badge.svg
   :target: https://github.com/adafruit/circuitpython/actions?query=branch%3Amain
.. |Doc Status| image:: https://readthedocs.org/projects/circuitpython/badge/?version=latest
   :target: http://circuitpython.readthedocs.io/
.. |Discord| image:: https://img.shields.io/discord/327254708534116352.svg
   :target: https://adafru.it/discord
.. |License| image:: https://img.shields.io/badge/License-MIT-brightgreen.svg
   :target: https://choosealicense.com/licenses/mit/
.. |Weblate| image:: https://hosted.weblate.org/widgets/circuitpython/-/svg-badge.svg
   :target: https://hosted.weblate.org/engage/circuitpython/?utm_source=widget