Go to file
Damien George c60a261ef0 py, vm: Replace save_ip, save_sp with code_state->{ip, sp}.
This may seem a bit of a risky change, in that it may introduce crazy
bugs with respect to volatile variables in the VM loop.  But, I think it
should be fine: code_state points to some external memory, so the
compiler should always read/write to that memory when accessing the
ip/sp variables (ie not put them in registers).

Anyway, it passes all tests and improves on all efficiency fronts: about
2-4% faster (64-bit unix), 16 bytes less stack space per call (64-bit
unix) and slightly less executable size (unix and stmhal).

The reason it's more efficient is save_ip and save_sp were volatile
variables, so were anyway stored on the stack (in memory, not regs).
Thus converting them to code_state->{ip, sp} doesn't cost an extra
memory dereference (except maybe to get code_state, but that can be put
in a register and then made more efficient for other uses of it).
2014-06-01 12:32:28 +01:00
bare-arm Rename configuration variables controling Python features. 2014-05-24 23:03:12 +01:00
examples py: Rename byte_code to bytecode everywhere. 2014-05-10 10:36:38 +01:00
logo Make GitHub logo/image a JPEG so it's smaller. 2014-01-14 23:55:53 +00:00
py py, vm: Replace save_ip, save_sp with code_state->{ip, sp}. 2014-06-01 12:32:28 +01:00
qemu-arm qemu-arm: Add port README. 2014-05-30 02:40:09 +03:00
stmhal Add a comma to make the .csv look proper in github 2014-05-30 22:18:52 -07:00
teensy Tidy up some configuration options. 2014-05-21 20:32:59 +01:00
tests tests: Add feature test for when heap allocation is disabled. 2014-05-31 18:33:16 +01:00
tools tools: Move gendoc.py to tools, and make it a little more generic. 2014-05-10 19:12:47 +01:00
unix unix: 64-bit cleanness. 2014-05-31 03:19:15 +03:00
unix-cpy Rename configuration variables controling Python features. 2014-05-24 23:03:12 +01:00
windows msvc: Only update generated headers when there are changes 2014-05-28 16:03:38 +02:00
.gitignore Ignore .exe files 2014-05-03 10:21:07 +02:00
.travis.yml travis: Add cross-compilation of mingw port 2014-05-11 19:33:13 +02:00
CODECONVENTIONS.md Add Python code conventions to CODECONVENTIONS. 2014-04-18 12:46:46 +01:00
LICENSE Add license header to (almost) all files. 2014-05-03 23:27:38 +01:00
README.md stm: Remove long-obsolete stm/ port. 2014-05-21 20:14:27 +01:00

[![Build Status][travis-img]][travis-repo] [travis-img]: https://travis-ci.org/micropython/micropython.png?branch=master [travis-repo]: https://travis-ci.org/micropython/micropython

The Micro Python project

MicroPython Logo

This is the Micro Python project, which aims to put an implementation of Python 3.x on a microcontroller.

WARNING: this project is in early beta stage and is subject to large changes of the code-base, including project-wide name changes and API changes.

Micro Python implements the entire Python 3.4 syntax (including exceptions, "with", "yield from", etc.). The following core datatypes are provided: str (no Unicode support yet), bytes, bytearray, tuple, list, dict, set, array.array, collections.namedtuple, classes and instances. Builtin modules include sys, time, and struct. Note that only subset of Python 3.4 functionality implemented for the data types and modules.

See the repository www.github.com/micropython/pyboard for the Micro Python board, the officially supported reference electronic circuit board.

Major components in this repository:

  • py/ -- the core Python implementation, including compiler and runtime.
  • unix/ -- a version of Micro Python that runs on Unix.
  • stmhal/ -- a version of Micro Python that runs on the Micro Python board with an STM32F405RG (using ST's Cube HAL drivers).
  • teensy/ -- a version of Micro Python that runs on the Teensy 3.1 (preliminary but functional).

Additional components:

  • bare-arm/ -- a bare minimum version of Micro Python for ARM MCUs. Start with this if you want to port Micro Python to another microcontroller.
  • unix-cpy/ -- a version of Micro Python that outputs bytecode (for testing).
  • tests/ -- test framework and test scripts.
  • tools/ -- various tools, including the pyboard.py module.
  • examples/ -- a few example Python scripts.

"make" is used to build the components, or "gmake" on BSD-based systems. You will also need bash and Python (at least 2.7 or 3.3).

The Unix version

The "unix" port requires a standard Unix environment with gcc and GNU make. x86 and x64 architectures are supported (i.e. x86 32- and 64-bit), as well as ARMv7. Porting to other architectures require writing some assembly code for the exception handling.

To build:

$ cd unix
$ make

Then to test it:

$ ./micropython
>>> list(5 * x + y for x in range(10) for y in [4, 2, 1])

Debian/Ubuntu/Mint derivative Linux distros will require build-essentials and libreadline-dev packages installed. To build FFI (Foreign Function Interface) module, libffi-dev package is required. If you have problems with some dependencies, they can be disabled in unix/mpconfigport.mk .

The STM version

The "stmhal" port requires an ARM compiler, arm-none-eabi-gcc, and associated bin-utils. For those using Arch Linux, you need arm-none-eabi-binutils and arm-none-eabi-gcc packages from the AUR. Otherwise, try here: https://launchpad.net/gcc-arm-embedded

To build:

$ cd stmhal
$ make

You then need to get your board into DFU mode. On the pyboard, connect the 3V3 pin to the P1/DFU pin with a wire (on PYBv1.0 they are next to each other on the bottom left of the board, second row from the bottom).

Then to flash the code via USB DFU to your device:

$ make deploy

You will need the dfu-util program, on Arch Linux it's dfu-util-git in the AUR. If the above does not work it may be because you don't have the correct permissions. Try then:

$ sudo dfu-util -a 0 -D build-PYBV10/firmware.dfu