docs: Bump version to 1.3.9.

It uses RAM and on pyboard we are generally tight on RAM, so disable
this optimisation for general builds.  If users need the speed then
they can build their own version.  Maybe in the future we can have
different versions of pyboard firmware built with different tradeoffs.

.gitignore

@@ -32,3 +32,6 @@ tests/*.out
 # Python cache files
 ######################
 __pycache__/
+
+# Customized Makefile overrides
+GNUmakefile

.travis.yml

@@ -7,15 +7,25 @@ before_script:
   - sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test
   - sudo add-apt-repository -y ppa:terry.guo/gcc-arm-embedded
   - sudo apt-get update -qq
-  - sudo apt-get install -y python3.3 python3 gcc-4.7 gcc-arm-none-eabi qemu-system
+  - sudo apt-get install -y python3.3 python3 gcc-4.7 gcc-multilib gcc-arm-none-eabi qemu-system mingw32
+  # For teensy build
+  - sudo apt-get install realpath
 
 script:
+  - make -C minimal test
   - make -C unix CC=gcc-4.7
   - make -C unix-cpy CC=gcc-4.7
   - make -C bare-arm
-  - make -C qemu-arm
+  - make -C qemu-arm test
   - make -C stmhal
+  - make -C stmhal -B MICROPY_PY_WIZNET5K=1 MICROPY_PY_CC3K=1
+  - make -C stmhal BOARD=STM32F4DISC
+  - make -C teensy
+  - make -C windows CROSS_COMPILE=i586-mingw32msvc-
+
   - (cd tests && MICROPY_CPYTHON3=python3.3 ./run-tests)
+  - (cd tests && MICROPY_CPYTHON3=python3.3 ./run-tests --emit native)
 
 after_failure:
-  - (cd tests && for exp in *.exp; do testbase=$(basename $exp .exp); echo -e "\nFAILURE $testbase"; diff $testbase.exp $testbase.out; done)
+  - (cd tests && for exp in *.exp; do testbase=$(basename $exp .exp); echo -e "\nFAILURE $testbase"; diff -u $testbase.exp $testbase.out; done)
+  - (grep "FAIL" qemu-arm/build/console.out)

CODECONVENTIONS.md

@@ -40,6 +40,17 @@ Header files:
 Type names and declarations:
 - When defining a type, put '_t' after it.
 
+Integer types: Micro Python runs on 32 and 64 bit machines (and one day
+maybe 16 bit), so it's important to use the correctly-sized (and signed)
+integer types.  The general guidelines are:
+- For most cases use mp_int_t for signed and mp_uint_t for unsigned
+  integer values.  These are guaranteed to be machine-word sized and
+  therefore big enough to hold the value from a Micro Python small-int
+  object.
+- Use size_t for things that count bytes / sizes of objects.
+- You can use int/uint, but remember that they may be 16-bits wide.
+- If in doubt, use mp_int_t/mp_uint_t.
+
 Examples
 --------
 

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013 Damien P. George
+Copyright (c) 2013, 2014 Damien P. George
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -5,32 +5,37 @@
 The Micro Python project
 ========================
 <p align="center">
-  <img src="https://raw2.github.com/micropython/micropython/master/logo/upython-with-micro.jpg" alt="MicroPython Logo"/>
+  <img src="https://raw.githubusercontent.com/micropython/micropython/master/logo/upython-with-micro.jpg" alt="MicroPython Logo"/>
 </p>
 
 This is the Micro Python project, which aims to put an implementation
 of Python 3.x on a microcontroller.
 
-WARNING: this project is in its early stages and is subject to large
+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.
+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 new Cube HAL drivers).
+  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.
-- stm/ -- obsolete version of Micro Python for the Micro Python board
-  that uses ST's old peripheral drivers.
 - 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.
@@ -44,23 +49,28 @@ 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.
+as ARM and MIPS. Making full-featured port to another architecture requires
+writing some assembly code for the exception handling and garbage collection.
+Alternatively, fallback implementation based on setjmp/longjmp can be used.
 
 To build:
 
     $ cd unix
     $ make
 
-Then to test it:
+Then to give it a try:
 
     $ ./micropython
     >>> list(5 * x + y for x in range(10) for y in [4, 2, 1])
 
+Run complete testsuite:
+
+    $ make test
+
 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 .
+module, libffi-dev and pkg-config packages are required. If you have problems
+with some dependencies, they can be disabled in unix/mpconfigport.mk .
 
 The STM version
 ---------------
@@ -81,6 +91,25 @@ on the bottom left of the board, second row from the bottom).
 
 Then to flash the code via USB DFU to your device:
 
-    $ dfu-util -a 0 -D build/flash.dfu
+    $ make deploy
 
-You will need the dfu-util program, on Arch Linux it's dfu-util-git in the AUR.
+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 0483:df11 -D build-PYBV10/firmware.dfu
+
+Building the documentation locally
+----------------------------------
+
+Install Sphinx, and optionally (for the RTD-styling), sphinx_rtd_theme,
+preferably in a virtualenv:
+
+     pip install sphinx
+     pip install sphinx_rtd_theme
+
+In `micropython/docs`, build the docs:
+
+    make html
+
+You'll find the index page at `micropython/docs/build/html/index.html`.

bare-arm/Makefile

@@ -9,11 +9,11 @@ include ../py/py.mk
 CROSS_COMPILE = arm-none-eabi-
 
 INC =  -I.
-INC += -I$(PY_SRC)
+INC += -I..
 INC += -I$(BUILD)
 
 CFLAGS_CORTEX_M4 = -mthumb -mtune=cortex-m4 -mabi=aapcs-linux -mcpu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard -fsingle-precision-constant -Wdouble-promotion
-CFLAGS = $(INC) -Wall -Werror -ansi -std=gnu99 $(CFLAGS_CORTEX_M4) $(COPT)
+CFLAGS = $(INC) -Wall -Werror -ansi -std=gnu99 -nostdlib $(CFLAGS_CORTEX_M4) $(COPT)
 
 #Debugging/Optimization
 ifeq ($(DEBUG), 1)
@@ -22,7 +22,7 @@ else
 CFLAGS += -Os -DNDEBUG
 endif
 
-LDFLAGS = --nostdlib -T stm32f405.ld
+LDFLAGS = -nostdlib -T stm32f405.ld -Map=$@.map --cref
 LIBS =
 
 SRC_C = \
@@ -38,9 +38,9 @@ SRC_S = \
 
 OBJ = $(PY_O) $(addprefix $(BUILD)/, $(SRC_C:.c=.o) $(SRC_S:.s=.o))
 
-all: $(BUILD)/flash.elf
+all: $(BUILD)/firmware.elf
 
-$(BUILD)/flash.elf: $(OBJ)
+$(BUILD)/firmware.elf: $(OBJ)
 	$(ECHO) "LINK $@"
 	$(Q)$(LD) $(LDFLAGS) -o $@ $(OBJ) $(LIBS)
 	$(Q)$(SIZE) $@

bare-arm/main.c

@@ -2,18 +2,12 @@
 #include <stdio.h>
 #include <string.h>
 
-#include "mpconfig.h"
-#include "nlr.h"
-#include "misc.h"
-#include "qstr.h"
-#include "lexer.h"
-#include "parse.h"
-#include "obj.h"
-#include "parsehelper.h"
-#include "compile.h"
-#include "runtime0.h"
-#include "runtime.h"
-#include "repl.h"
+#include "py/nlr.h"
+#include "py/parsehelper.h"
+#include "py/compile.h"
+#include "py/runtime.h"
+#include "py/repl.h"
+#include "py/pfenv.h"
 
 void do_str(const char *src) {
     mp_lexer_t *lex = mp_lexer_new_from_str_len(MP_QSTR__lt_stdin_gt_, src, strlen(src), 0);
@@ -32,13 +26,13 @@ void do_str(const char *src) {
     }
 
     // parse okay
-    qstr source_name = mp_lexer_source_name(lex);
+    qstr source_name = lex->source_name;
     mp_lexer_free(lex);
     mp_obj_t module_fun = mp_compile(pn, source_name, MP_EMIT_OPT_NONE, true);
-    mp_parse_node_free(pn);
 
-    if (module_fun == mp_const_none) {
+    if (mp_obj_is_exception_instance(module_fun)) {
         // compile error
+        mp_obj_print_exception(printf_wrapper, NULL, module_fun);
         return;
     }
 
@@ -48,12 +42,11 @@ void do_str(const char *src) {
         nlr_pop();
     } else {
         // uncaught exception
-        mp_obj_print_exception((mp_obj_t)nlr.ret_val);
+        mp_obj_print_exception(printf_wrapper, NULL, (mp_obj_t)nlr.ret_val);
     }
 }
 
 int main(int argc, char **argv) {
-    qstr_init();
     mp_init();
     do_str("print('hello world!', list(x+1 for x in range(10)), end='eol\n')");
     mp_deinit();
@@ -71,14 +64,25 @@ mp_import_stat_t mp_import_stat(const char *path) {
     return MP_IMPORT_STAT_NO_EXIST;
 }
 
-mp_obj_t mp_builtin_open(uint n_args, const mp_obj_t *args) {
+mp_obj_t mp_builtin_open(uint n_args, const mp_obj_t *args, mp_map_t *kwargs) {
     return mp_const_none;
 }
-MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_builtin_open_obj, 1, 2, mp_builtin_open);
+MP_DEFINE_CONST_FUN_OBJ_KW(mp_builtin_open_obj, 1, mp_builtin_open);
 
 void nlr_jump_fail(void *val) {
 }
 
+void NORETURN __fatal_error(const char *msg) {
+    while (1);
+}
+
+#ifndef NDEBUG
+void MP_WEAK __assert_func(const char *file, int line, const char *func, const char *expr) {
+    printf("Assertion '%s' failed, at file %s:%d\n", expr, file, line);
+    __fatal_error("Assertion failed");
+}
+#endif
+
 /*
 int _lseek() {return 0;}
 int _read() {return 0;}

bare-arm/mpconfigport.h

@@ -2,41 +2,58 @@
 
 // options to control how Micro Python is built
 
+#define MICROPY_ALLOC_PATH_MAX      (512)
 #define MICROPY_EMIT_X64            (0)
 #define MICROPY_EMIT_THUMB          (0)
 #define MICROPY_EMIT_INLINE_THUMB   (0)
+#define MICROPY_COMP_MODULE_CONST   (0)
+#define MICROPY_COMP_CONST          (0)
 #define MICROPY_MEM_STATS           (0)
 #define MICROPY_DEBUG_PRINTERS      (0)
 #define MICROPY_ENABLE_GC           (0)
-#define MICROPY_ENABLE_REPL_HELPERS (0)
-#define MICROPY_ENABLE_LEXER_UNIX   (0)
+#define MICROPY_HELPER_REPL         (0)
+#define MICROPY_HELPER_LEXER_UNIX   (0)
 #define MICROPY_ENABLE_SOURCE_LINE  (0)
-#define MICROPY_ENABLE_MOD_COLLECTIONS (0)
-#define MICROPY_ENABLE_MOD_MATH     (0)
-#define MICROPY_ENABLE_MOD_CMATH    (0)
-#define MICROPY_ENABLE_MOD_IO       (0)
-#define MICROPY_ENABLE_MOD_STRUCT   (0)
-#define MICROPY_ENABLE_MOD_SYS      (0)
-#define MICROPY_ENABLE_PROPERTY     (0)
+#define MICROPY_ENABLE_DOC_STRING   (0)
+#define MICROPY_ERROR_REPORTING     (MICROPY_ERROR_REPORTING_TERSE)
+#define MICROPY_PY_BUILTINS_BYTEARRAY (0)
+#define MICROPY_PY_BUILTINS_MEMORYVIEW (0)
+#define MICROPY_PY_BUILTINS_FROZENSET (0)
+#define MICROPY_PY_BUILTINS_SET     (0)
+#define MICROPY_PY_BUILTINS_SLICE   (0)
+#define MICROPY_PY_BUILTINS_PROPERTY (0)
+#define MICROPY_PY___FILE__         (0)
+#define MICROPY_PY_GC               (0)
+#define MICROPY_PY_ARRAY            (0)
+#define MICROPY_PY_COLLECTIONS      (0)
+#define MICROPY_PY_MATH             (0)
+#define MICROPY_PY_CMATH            (0)
+#define MICROPY_PY_IO               (0)
+#define MICROPY_PY_STRUCT           (0)
+#define MICROPY_PY_SYS              (0)
 #define MICROPY_CPYTHON_COMPAT      (0)
 #define MICROPY_LONGINT_IMPL        (MICROPY_LONGINT_IMPL_NONE)
 #define MICROPY_FLOAT_IMPL          (MICROPY_FLOAT_IMPL_NONE)
-#define MICROPY_PATH_MAX            (512)
 
 // type definitions for the specific machine
 
 #define BYTES_PER_WORD (4)
 
+#define MICROPY_MAKE_POINTER_CALLABLE(p) ((void*)((mp_uint_t)(p) | 1))
+
 #define UINT_FMT "%lu"
 #define INT_FMT "%ld"
 
-typedef int32_t machine_int_t; // must be pointer size
-typedef uint32_t machine_uint_t; // must be pointer size
+typedef int32_t mp_int_t; // must be pointer size
+typedef uint32_t mp_uint_t; // must be pointer size
 typedef void *machine_ptr_t; // must be of pointer size
 typedef const void *machine_const_ptr_t; // must be of pointer size
+typedef long mp_off_t;
 
 // extra built in names to add to the global namespace
-extern const struct _mp_obj_fun_native_t mp_builtin_open_obj;
-#define MICROPY_EXTRA_BUILTINS \
+extern const struct _mp_obj_fun_builtin_t mp_builtin_open_obj;
+#define MICROPY_PORT_BUILTINS \
     { MP_OBJ_NEW_QSTR(MP_QSTR_open), (mp_obj_t)&mp_builtin_open_obj },
 
+// We need to provide a declaration/definition of alloca()
+#include <alloca.h>

docs/Makefile

@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MicroPython.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MicroPython.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/MicroPython"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MicroPython"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/conf.py

@@ -0,0 +1,279 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Micro Python documentation build configuration file, created by
+# sphinx-quickstart on Sun Sep 21 11:42:03 2014.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys
+import os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = 'Micro Python'
+copyright = '2014, Damien P. George'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '1.3'
+# The full version, including alpha/beta/rc tags.
+release = '1.3.9'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# on_rtd is whether we are on readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    try:
+        import sphinx_rtd_theme
+        html_theme = 'sphinx_rtd_theme'
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+    except:
+        html_theme = 'default'
+        html_theme_path = ['.']
+else:
+    html_theme_path = ['.']
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = ['.']
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = '../logo/trans-logo.png'
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+html_last_updated_fmt = '%d %b %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+html_additional_pages = {"index": "topindex.html"}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MicroPythondoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+  ('index', 'MicroPython.tex', 'Micro Python Documentation',
+   'Damien P. George', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'micropython', 'Micro Python Documentation',
+     ['Damien P. George'], 1),
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'MicroPython', 'Micro Python Documentation',
+   'Damien P. George', 'MicroPython', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

docs/contents.rst

@@ -0,0 +1,11 @@
+Micro Python documentation contents
+===================================
+
+.. toctree::
+
+   quickref.rst
+   general.rst
+   tutorial/index.rst
+   library/index.rst
+   hardware/index.rst
+   license.rst

docs/general.rst

@@ -0,0 +1,62 @@
+General information about the pyboard
+=====================================
+
+Local filesystem and SD card
+----------------------------
+
+There is a small internal filesystem (a drive) on the pyboard, called ``/flash``,
+which is stored within the microcontroller's flash memory.  If a micro SD card
+is inserted into the slot, it is available as ``/sd``.
+
+When the pyboard boots up, it needs to choose a filesystem to boot from.  If
+there is no SD card, then it uses the internal filesystem ``/flash`` as the boot
+filesystem, otherwise, it uses the SD card ``/sd``.
+
+(Note that on older versions of the board, ``/flash`` is called ``0:/`` and ``/sd``
+is called ``1:/``).
+
+The boot filesystem is used for 2 things: it is the filesystem from which
+the ``boot.py`` and ``main.py`` files are searched for, and it is the filesystem
+which is made available on your PC over the USB cable.
+
+The filesystem will be available as a USB flash drive on your PC.  You can
+save files to the drive, and edit ``boot.py`` and ``main.py``.
+
+*Remember to eject (on Linux, unmount) the USB drive before you reset your
+pyboard.*
+
+Boot modes
+----------
+
+If you power up normally, or press the reset button, the pyboard will boot
+into standard mode: the ``boot.py`` file will be executed first, then the
+USB will be configured, then ``main.py`` will run.
+
+You can override this boot sequence by holding down the user switch as
+the board is booting up.  Hold down user switch and press reset, and then
+as you continue to hold the user switch, the LEDs will count in binary.
+When the LEDs have reached the mode you want, let go of the user switch,
+the LEDs for the selected mode will flash quickly, and the board will boot.
+
+The modes are:
+
+1. Green LED only, *standard boot*: run ``boot.py`` then ``main.py``.
+2. Orange LED only, *safe boot*: don't run any scripts on boot-up.
+3. Green and orange LED together, *filesystem reset*: resets the flash
+   filesystem to its factory state, then boots in safe mode.
+
+If your filesystem becomes corrupt, boot into mode 3 to fix it.
+If resetting the filesystem while plugged into your compute doesn't work,
+you can try doing the same procedure while the board is plugged into a USB
+charger, or other USB power supply without data connection.
+
+Errors: flashing LEDs
+---------------------
+
+There are currently 2 kinds of errors that you might see:
+
+1. If the red and green LEDs flash alternatively, then a Python script
+    (eg ``main.py``) has an error.  Use the REPL to debug it.
+2. If all 4 LEDs cycle on and off slowly, then there was a hard fault.
+   This cannot be recovered from and you need to do a hard reset.
+

docs/hardware/index.rst

@@ -0,0 +1,29 @@
+.. _hardware_index:
+
+The pyboard hardware
+====================
+
+For the pyboard:
+
+* `PYBv1.0 schematics and layout <http://micropython.org/resources/PYBv10b.pdf>`_ (2.4MiB PDF)
+* `PYBv1.0 metric dimensions <http://micropython.org/resources/PYBv10b-metric-dimensions.pdf>`_ (360KiB PDF)
+* `PYBv1.0 imperial dimensions <http://micropython.org/resources/PYBv10b-imperial-dimensions.pdf>`_ (360KiB PDF)
+
+For the official skin modules:
+
+* `LCD32MKv1.0 schematics <http://micropython.org/resources/LCD32MKv10-schematics.pdf>`_ (194KiB PDF)
+* `AMPv1.0 schematics <http://micropython.org/resources/AMPv10-schematics.pdf>`_ (209KiB PDF)
+
+Datasheets for the components on the pyboard
+============================================
+
+* The microcontroller: `STM32F405RGT6 <http://www.st.com/web/catalog/mmc/FM141/SC1169/SS1577/LN1035/PF252144>`_ (link to manufacturer's site)
+* The accelerometer: `Freescale MMA7660 <http://micropython.org/resources/datasheets/MMA7660FC.pdf>`_ (800kiB PDF)
+* The LDO voltage regulator: `Microchip MCP1802 <http://micropython.org/resources/datasheets/MCP1802-22053C.pdf>`_ (400kiB PDF)
+
+Datasheets for other components
+===============================
+
+* The LCD display on the LCD touch-sensor skin: `Newhaven Display NHD-C12832A1Z-FSW-FBW-3V3 <http://micropython.org/resources/datasheets/NHD-C12832A1Z-FSW-FBW-3V3.pdf>`_ (460KiB PDF)
+* The touch sensor chip on the LCD touch-sensor skin: `Freescale MPR121 <http://micropython.org/resources/datasheets/MPR121.pdf>`_ (280KiB PDF)
+* The digital potentiometer on the audio skin: `Microchip MCP4541 <http://micropython.org/resources/datasheets/MCP4541-22107B.pdf>`_ (2.7MiB PDF)

docs/index.rst

@@ -0,0 +1,19 @@
+Micro Python documentation and references
+=========================================
+
+.. toctree::
+
+   quickref.rst
+   general.rst
+   tutorial/index.rst
+   library/index.rst
+   hardware/index.rst
+   license.rst
+   contents.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/library/cmath.rst

@@ -0,0 +1,58 @@
+:mod:`cmath` -- mathematical functions for complex numbers
+==========================================================
+
+.. module:: cmath
+   :synopsis: mathematical functions for complex numbers
+
+The ``cmath`` module provides some basic mathematical funtions for
+working with complex numbers.
+
+Functions
+---------
+
+.. function:: cos(z)
+
+   Return the cosine of ``z``.
+
+.. function:: exp(z)
+
+   Return the exponential of ``z``.
+
+.. function:: log(z)
+
+   Return the natural logarithm of ``z``.  The branch cut is along the negative real axis.
+
+.. function:: log10(z)
+
+   Return the base-10 logarithm of ``z``.  The branch cut is along the negative real axis.
+
+.. function:: phase(z)
+
+   Returns the phase of the number ``z``, in the range (-pi, +pi].
+
+.. function:: polar(z)
+
+   Returns, as a tuple, the polar form of ``z``.
+
+.. function:: rect(r, phi)
+
+   Returns the complex number with modulus ``r`` and phase ``phi``.
+
+.. function:: sin(z)
+
+   Return the sine of ``z``.
+
+.. function:: sqrt(z)
+
+   Return the square-root of ``z``.
+
+Constants
+---------
+
+.. data:: e
+
+   base of the natural logarithm
+
+.. data:: pi
+
+   the ratio of a circle's circumference to its diameter

docs/library/gc.rst

@@ -0,0 +1,29 @@
+:mod:`gc` -- control the garbage collector
+==========================================
+
+.. module:: gc
+   :synopsis: control the garbage collector
+
+Functions
+---------
+
+.. function:: enable()
+
+   Enable automatic garbage collection.
+
+.. function:: disable()
+
+   Disable automatic garbage collection.  Heap memory can still be allocated,
+   and garbage collection can still be initiated manually using :meth:`gc.collect`.
+
+.. function:: collect()
+
+   Run a garbage collection.
+
+.. function:: mem_alloc()
+
+   Return the number of bytes of heap RAM that are allocated.
+
+.. function:: mem_free()
+
+   Return the number of bytes of available heap RAM.

docs/library/index.rst

@@ -0,0 +1,59 @@
+Micro Python libraries
+======================
+
+Python standard libraries
+-------------------------
+
+The following standard Python libraries are built in to Micro Python.
+
+For additional libraries, please download them from the `micropython-lib repository
+<https://github.com/micropython/micropython-lib>`_.
+
+.. toctree::
+   :maxdepth: 1
+
+   cmath.rst
+   gc.rst
+   math.rst
+   os.rst
+   select.rst
+   struct.rst
+   sys.rst
+   time.rst
+
+Python micro-libraries
+----------------------
+
+The following standard Python libraries have been "micro-ified" to fit in with
+the philosophy of Micro Python.  They provide the core functionality of that
+module and are intended to be a drop-in replacement for the standard Python
+library.
+
+The modules are available by their u-name, and also by their non-u-name.  The
+non-u-name can be overridden by a file of that name in your package path.
+For example, ``import json`` will first search for a file ``json.py`` or
+directory ``json`` and load that package if it is found.  If nothing is found,
+it will fallback to loading the built-in ``ujson`` module.
+
+.. toctree::
+   :maxdepth: 1
+
+   ubinascii.rst
+   uctypes.rst
+   uhashlib.rst
+   uheapq.rst
+   ujson.rst
+   ure.rst
+   usocket.rst
+   uzlib.rst
+
+Libraries specific to the pyboard
+---------------------------------
+
+The following libraries are specific to the pyboard.
+
+.. toctree::
+   :maxdepth: 2
+
+   pyb.rst
+   network.rst

docs/library/math.rst

@@ -0,0 +1,177 @@
+:mod:`math` -- mathematical functions
+=====================================
+
+.. module:: math
+   :synopsis: mathematical functions
+
+The ``math`` module provides some basic mathematical funtions for
+working with floating-point numbers.
+
+*Note:* On the pyboard, floating-point numbers have 32-bit precision.
+
+Functions
+---------
+
+.. function:: acos(x)
+
+   Return the inverse cosine of ``x``.
+
+.. function:: acosh(x)
+
+   Return the inverse hyperbolic cosine of ``x``.
+
+.. function:: asin(x)
+
+   Return the inverse sine of ``x``.
+
+.. function:: asinh(x)
+
+   Return the inverse hyperbolic sine of ``x``.
+
+.. function:: atan(x)
+
+   Return the inverse tangent of ``x``.
+
+.. function:: atan2(y, x)
+
+   Return the principal value of the inverse tangent of ``y/x``.
+
+.. function:: atanh(x)
+
+   Return the inverse hyperbolic tangent of ``x``.
+
+.. function:: ceil(x)
+
+   Return an integer, being ``x`` rounded towards positive infinity.
+
+.. function:: copysign(x, y)
+
+   Return ``x`` with the sign of ``y``.
+
+.. function:: cos(x)
+
+   Return the cosine of ``x``.
+
+.. function:: cosh(x)
+
+   Return the hyperbolic cosine of ``x``.
+
+.. function:: degrees(x)
+
+   Return radians ``x`` converted to degrees.
+
+.. function:: erf(x)
+
+   Return the error function of ``x``.
+
+.. function:: erfc(x)
+
+   Return the complementary error function of ``x``.
+
+.. function:: exp(x)
+
+   Return the exponential of ``x``.
+
+.. function:: expm1(x)
+
+   Return ``exp(x) - 1``.
+
+.. function:: fabs(x)
+
+   Return the absolute value of ``x``.
+
+.. function:: floor(x)
+
+   Return an integer, being ``x`` rounded towards negative infinity.
+
+.. function:: fmod(x, y)
+
+   Return the remainder of ``x/y``.
+
+.. function:: frexp(x)
+
+   Converts a floating-point number to fractional and integral components.
+
+.. function:: gamma(x)
+
+   Return the gamma function of ``x``.
+
+.. function:: isfinite(x)
+
+   Return ``True`` if ``x`` is finite.
+
+.. function:: isinf(x)
+
+   Return ``True`` if ``x`` is infinite.
+
+.. function:: isnan(x)
+
+   Return ``True`` if ``x`` is not-a-number
+
+.. function:: ldexp(x, exp)
+
+   Return ``x * (2**exp)``.
+
+.. function:: lgamma(x)
+
+   Return the natural logarithm of the gamma function of ``x``.
+
+.. function:: log(x)
+
+   Return the natural logarithm of ``x``.
+
+.. function:: log10(x)
+
+   Return the base-10 logarithm of ``x``.
+
+.. function:: log2(x)
+
+   Return the base-2 logarithm of ``x``.
+
+.. function:: modf(x)
+
+   Return a tuple of two floats, being the fractional and integral parts of
+   ``x``.  Both return values have the same sign as ``x``.
+
+.. function:: pow(x, y)
+
+   Returns ``x`` to the power of ``y``.
+
+.. function:: radians(x)
+
+   Return degrees ``x`` converted to radians.
+
+.. function:: sin(x)
+
+   Return the sine of ``x``.
+
+.. function:: sinh(x)
+
+   Return the hyperbolic sine of ``x``.
+
+.. function:: sqrt(x)
+
+   Return the square root of ``x``.
+
+.. function:: tan(x)
+
+   Return the tangent of ``x``.
+
+.. function:: tanh(x)
+
+   Return the hyperbolic tangent of ``x``.
+
+.. function:: trunc(x)
+
+   Return an integer, being ``x`` rounded towards 0.
+
+Constants
+---------
+
+.. data:: e
+
+   base of the natural logarithm
+
+.. data:: pi
+
+   the ratio of a circle's circumference to its diameter

docs/library/network.rst

@@ -0,0 +1,177 @@
+****************************************
+:mod:`network` --- network configuration
+****************************************
+
+.. module:: network
+   :synopsis: network configuration
+
+This module provides network drivers and routing configuration.  Network
+drivers for specific hardware are available within this module and are
+used to configure a hardware network interface.  Configured interfaces
+are then available for use via the :mod:`socket` module.
+
+For example::
+
+    # configure a specific network interface
+    # see below for examples of specific drivers
+    import network
+    nic = network.Driver(...)
+    print(nic.ifconfig())
+
+    # now use socket as usual
+    import socket
+    addr = socket.getaddrinfo('micropython.org', 80)[0][-1]
+    s = socket.socket()
+    s.connect(addr)
+    s.send(b'GET / HTTP/1.1\r\nHost: micropython.org\r\n\r\n')
+    data = s.recv(1000)
+    s.close()
+
+class CC3K
+==========
+
+This class provides a driver for CC3000 wifi modules.  Example usage::
+
+    import network
+    nic = network.CC3K(pyb.SPI(2), pyb.Pin.board.Y5, pyb.Pin.board.Y4, pyb.Pin.board.Y3)
+    nic.connect('your-ssid', 'your-password')
+    while not nic.isconnected():
+        pyb.delay(50)
+    print(nic.ifconfig())
+
+    # now use socket as usual
+    ...
+
+For this example to work the CC3000 module must have the following connections:
+
+    - MOSI connected to Y8
+    - MISO connected to Y7
+    - CLK connected to Y6
+    - CS connected to Y5
+    - VBEN connected to Y4
+    - IRQ connected to Y3
+
+It is possible to use other SPI busses and other pins for CS, VBEN and IRQ.
+
+Constructors
+------------
+
+.. class:: CC3K(spi, pin_cs, pin_en, pin_irq)
+
+   Create a CC3K driver object, initialise the CC3000 module using the given SPI bus
+   and pins, and return the CC3K object.
+
+   Arguments are:
+
+     - ``spi`` is an :ref:`SPI object <pyb.SPI>` which is the SPI bus that the CC3000 is
+       connected to (the MOSI, MISO and CLK pins).
+     - ``pin_cs`` is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 CS pin.
+     - ``pin_en`` is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 VBEN pin.
+     - ``pin_irq`` is a :ref:`Pin object <pyb.Pin>` which is connected to the CC3000 IRQ pin.
+
+   All of these objects will be initialised by the driver, so there is no need to
+   initialise them yourself.  For example, you can use::
+
+     nic = network.CC3K(pyb.SPI(2), pyb.Pin.board.Y5, pyb.Pin.board.Y4, pyb.Pin.board.Y3)
+
+Methods
+-------
+
+.. method:: cc3k.connect(ssid, key=None, \*, security=WPA2, bssid=None)
+
+   Connect to a wifi access point using the given SSID, and other security
+   parameters.
+
+.. method:: cc3k.disconnect()
+
+   Disconnect from the wifi access point.
+
+.. method:: cc3k.isconnected()
+
+   Returns True if connected to a wifi access point and has a valid IP address,
+   False otherwise.
+
+.. method:: cc3k.ifconfig()
+
+   Returns a 7-tuple with (ip, subnet mask, gateway, DNS server, DHCP server,
+   MAC address, SSID).
+
+.. method:: cc3k.patch_version()
+
+   Return the version of the patch program (firmware) on the CC3000.
+
+.. method:: cc3k.patch_program('pgm')
+
+   Upload the current firmware to the CC3000.  You must pass 'pgm' as the first
+   argument in order for the upload to proceed.
+
+Constants
+---------
+
+.. data:: CC3K.WEP
+.. data:: CC3K.WPA
+.. data:: CC3K.WPA2
+
+   security type to use
+
+class WIZNET5K
+==============
+
+This class allows you to control WIZnet5x00 Ethernet adaptors based on
+the W5200 and W5500 chipsets (only W5200 tested).
+
+Example usage::
+
+    import network
+    nic = network.WIZNET5K(pyb.SPI(1), pyb.Pin.board.X5, pyb.Pin.board.X4)
+    print(nic.ifconfig())
+
+    # now use socket as usual
+    ...
+
+For this example to work the WIZnet5x00 module must have the following connections:
+
+    - MOSI connected to X8
+    - MISO connected to X7
+    - SCLK connected to X6
+    - nSS connected to X5
+    - nRESET connected to X4
+
+It is possible to use other SPI busses and other pins for nSS and nRESET.
+
+Constructors
+------------
+
+.. class:: WIZNET5K(spi, pin_cs, pin_rst)
+
+   Create a WIZNET5K driver object, initialise the WIZnet5x00 module using the given
+   SPI bus and pins, and return the WIZNET5K object.
+
+   Arguments are:
+
+     - ``spi`` is an :ref:`SPI object <pyb.SPI>` which is the SPI bus that the WIZnet5x00 is
+       connected to (the MOSI, MISO and SCLK pins).
+     - ``pin_cs`` is a :ref:`Pin object <pyb.Pin>` which is connected to the WIZnet5x00 nSS pin.
+     - ``pin_rst`` is a :ref:`Pin object <pyb.Pin>` which is connected to the WIZnet5x00 nRESET pin.
+
+   All of these objects will be initialised by the driver, so there is no need to
+   initialise them yourself.  For example, you can use::
+
+     nic = network.WIZNET5K(pyb.SPI(1), pyb.Pin.board.X5, pyb.Pin.board.X4)
+
+Methods
+-------
+
+.. method:: wiznet5k.ifconfig([(ip, subnet, gateway, dns)])
+
+   Get/set IP address, subnet mask, gateway and DNS.
+
+   When called with no arguments, this method returns a 4-tuple with the above information.
+
+   To set the above values, pass a 4-tuple with the required information.  For example::
+
+    nic.ifconfig(('192.168.0.4', '255.255.255.0', '192.168.0.1', '8.8.8.8'))
+
+.. method:: wiznet5k.regs()
+
+   Dump the WIZnet5x00 registers.  Useful for debugging.

docs/library/os.rst

@@ -0,0 +1,67 @@
+:mod:`os` -- basic "operating system" services
+==============================================
+
+.. module:: os
+   :synopsis: basic "operating system" services
+
+The ``os`` module contains functions for filesystem access and ``urandom``.
+
+Pyboard specifics
+-----------------
+
+The filesystem on the pyboard has ``/`` as the root directory and the
+available physical drives are accessible from here.  They are currently:
+
+    ``/flash``      -- the internal flash filesystem
+
+    ``/sd``         -- the SD card (if it exists)
+
+On boot up, the current directory is ``/flash`` if no SD card is inserted,
+otherwise it is ``/sd``.
+
+Functions
+---------
+
+.. function:: chdir(path)
+
+   Change current directory.
+
+.. function:: getcwd()
+
+   Get the current directory.
+
+.. function:: listdir([dir])
+
+   With no argument, list the current directory.  Otherwise list the given directory.
+
+.. function:: mkdir(path)
+
+   Create a new directory.
+
+.. function:: remove(path)
+
+   Remove a file.
+
+.. function:: rmdir(path)
+
+   Remove a directory.
+
+.. function:: stat(path)
+
+   Get the status of a file or directory.
+
+.. function:: sync()
+
+   Sync all filesystems.
+
+.. function:: urandom(n)
+
+   Return a bytes object with n random bytes, generated by the hardware
+   random number generator.
+
+Constants
+---------
+
+.. data:: sep
+
+   separation character used in paths

docs/library/pyb.ADC.rst

@@ -0,0 +1,52 @@
+.. _pyb.ADC:
+
+class ADC -- analog to digital conversion: read analog values on a pin
+======================================================================
+
+Usage::
+
+    import pyb
+
+    adc = pyb.ADC(pin)              # create an analog object from a pin
+    val = adc.read()                # read an analog value
+
+    adc = pyb.ADCAll(resolution)    # creale an ADCAll object
+    val = adc.read_channel(channel) # read the given channel
+    val = adc.read_core_temp()      # read MCU temperature
+    val = adc.read_core_vbat()      # read MCU VBAT
+    val = adc.read_core_vref()      # read MCU VREF
+
+
+Constructors
+------------
+
+.. class:: pyb.ADC(pin)
+
+   Create an ADC object associated with the given pin.
+   This allows you to then read analog values on that pin.
+
+
+Methods
+-------
+
+.. method:: adc.read()
+
+   Read the value on the analog pin and return it.  The returned value
+   will be between 0 and 4095.
+
+.. method:: adc.read_timed(buf, freq)
+
+   Read analog values into the given buffer at the given frequency. Buffer
+   can be bytearray or array.array for example. If a buffer with 8-bit elements
+   is used, sample resolution will be reduced to 8 bits.
+   
+   Example::
+   
+       adc = pyb.ADC(pyb.Pin.board.X19)    # create an ADC on pin X19
+       buf = bytearray(100)                # create a buffer of 100 bytes
+       adc.read_timed(buf, 10)             # read analog values into buf at 10Hz
+                                           #   this will take 10 seconds to finish
+       for val in buf:                     # loop over all values
+           print(val)                      # print the value out
+   
+   This function does not allocate any memory.

docs/library/pyb.Accel.rst

@@ -0,0 +1,51 @@
+class Accel -- accelerometer control
+====================================
+
+Accel is an object that controls the accelerometer.  Example usage::
+
+    accel = pyb.Accel()
+    for i in range(10):
+        print(accel.x(), accel.y(), accel.z())
+
+Raw values are between -32 and 31.
+
+
+Constructors
+------------
+
+.. class:: pyb.Accel()
+
+   Create and return an accelerometer object.
+   
+   Note: if you read accelerometer values immediately after creating this object
+   you will get 0.  It takes around 20ms for the first sample to be ready, so,
+   unless you have some other code between creating this object and reading its
+   values, you should put a ``pyb.delay(20)`` after creating it.  For example::
+   
+       accel = pyb.Accel()
+       pyb.delay(20)
+       print(accel.x())
+
+
+Methods
+-------
+
+.. method:: accel.filtered_xyz()
+
+   Get a 3-tuple of filtered x, y and z values.
+
+.. method:: accel.tilt()
+
+   Get the tilt register.
+
+.. method:: accel.x()
+
+   Get the x-axis value.
+
+.. method:: accel.y()
+
+   Get the y-axis value.
+
+.. method:: accel.z()
+
+   Get the z-axis value.

docs/library/pyb.CAN.rst

@@ -0,0 +1,154 @@
+class CAN -- controller area network communication bus
+======================================================
+
+CAN implements the standard CAN communications protocol.  At
+the physical level it consists of 2 lines: RX and TX.  Note that
+to connect the pyboard to a CAN bus you must use a CAN transceiver
+to convert the CAN logic signals from the pyboard to the correct
+voltage levels on the bus.
+
+Example usage (works without anything connected)::
+
+    from pyb import CAN
+    can = CAN(1, CAN.LOOPBACK)
+    can.setfilter(0, CAN.LIST16, 0, (123, 124, 125, 126))  # set a filter to receive messages with id=123, 124, 125 and 126
+    can.send('message!', 123)   # send a message with id 123
+    can.recv(0)                 # receive message on FIFO 0
+
+
+Constructors
+------------
+
+.. class:: pyb.CAN(bus, ...)
+
+   Construct a CAN object on the given bus.  ``bus`` can be 1-2, or 'YA' or 'YB'.
+   With no additional parameters, the CAN object is created but not
+   initialised (it has the settings from the last initialisation of
+   the bus, if any).  If extra arguments are given, the bus is initialised.
+   See ``init`` for parameters of initialisation.
+   
+   The physical pins of the CAN busses are:
+   
+     - ``CAN(1)`` is on ``YA``: ``(RX, TX) = (Y3, Y4) = (PB8, PB9)``
+     - ``CAN(2)`` is on ``YB``: ``(RX, TX) = (Y5, Y6) = (PB12, PB13)``
+
+Class Methods
+-------------
+.. method:: CAN.initfilterbanks(nr)
+   
+   Reset and disable all filter banks and assign how many banks should be available for CAN(1).
+   
+   STM32F405 has 28 filter banks that are shared between the two available CAN bus controllers.
+   This function configures how many filter banks should be assigned to each. ``nr`` is the number of banks 
+   that will be assigned to CAN(1), the rest of the 28 are assigned to CAN(2). 
+   At boot, 14 banks are assigned to each controller.
+ 
+Methods
+-------
+
+.. method:: can.init(mode, extframe=False, prescaler=100, \*, sjw=1, bs1=6, bs2=8)
+
+   Initialise the CAN bus with the given parameters:
+   
+     - ``mode`` is one of:  NORMAL, LOOPBACK, SILENT, SILENT_LOOPBACK
+     - if ``extframe`` is True then the bus uses extended identifiers in the frames
+       (29 bits); otherwise it uses standard 11 bit identifiers
+     - ``prescaler`` is used to set the duration of 1 time quanta; the time quanta
+       will be the input clock (PCLK1, see :meth:`pyb.freq()`) divided by the prescaler
+     - ``sjw`` is the resynchronisation jump width in units of the time quanta;
+       it can be 1, 2, 3, 4
+     - ``bs1`` defines the location of the sample point in units of the time quanta;
+       it can be between 1 and 1024 inclusive
+     - ``bs2`` defines the location of the transmit point in units of the time quanta;
+       it can be between 1 and 16 inclusive
+
+   The time quanta tq is the basic unit of time for the CAN bus.  tq is the CAN
+   prescaler value divided by PCLK1 (the frequency of internal peripheral bus 1);
+   see :meth:`pyb.freq()` to determine PCLK1.
+
+   A single bit is made up of the synchronisation segment, which is always 1 tq.
+   Then follows bit segment 1, then bit segment 2.  The sample point is after bit
+   segment 1 finishes.  The transmit point is after bit segment 2 finishes.
+   The baud rate will be 1/bittime, where the bittime is 1 + BS1 + BS2 multiplied
+   by the time quanta tq.
+
+   For example, with PCLK1=42MHz, prescaler=100, sjw=1, bs1=6, bs2=8, the value of
+   tq is 2.38 microseconds.  The bittime is 35.7 microseconds, and the baudrate
+   is 28kHz.
+
+   See page 680 of the STM32F405 datasheet for more details.
+
+.. method:: can.deinit()
+
+   Turn off the CAN bus.
+
+.. method:: can.setfilter(bank, mode, fifo, params)
+   
+   Configure a filter bank:
+   
+   - ``bank`` is the filter bank that is to be configured.
+   - ``mode`` is the mode the filter should operate in.
+   - ``fifo`` is which fifo (0 or 1) a message should be stored in, if it is accepted by this filter.   
+   - ``params`` is an array of values the defines the filter. The contents of the array depends on the ``mode`` argument.
+    
+   +-----------+---------------------------------------------------------+
+   |``mode``   |contents of parameter array                              |
+   +===========+=========================================================+
+   |CAN.LIST16 |Four 16 bit ids that will be accepted                    |
+   +-----------+---------------------------------------------------------+
+   |CAN.LIST32 |Two 32 bit ids that will be accepted                     |
+   +-----------+---------------------------------------------------------+
+   |CAN.MASK16 |Two 16 bit id/mask pairs. E.g. (1, 3, 4, 4)              |
+   |           | | The first pair, 1 and 3 will accept all ids           |
+   |           | | that have bit 0 = 1 and bit 1 = 0.                    |
+   |           | | The second pair, 4 and 4, will accept all ids         |
+   |           | | that have bit 2 = 1.                                  |
+   +-----------+---------------------------------------------------------+
+   |CAN.MASK32 |As with CAN.MASK16 but with only one 32 bit id/mask pair.|
+   +-----------+---------------------------------------------------------+
+   
+.. method:: can.clearfilter(bank)
+
+   Clear and disables a filter bank:
+   
+   - ``bank`` is the filter bank that is to be cleared.
+
+.. method:: can.any(fifo)
+
+   Return ``True`` if any message waiting on the FIFO, else ``False``.
+
+.. method:: can.recv(fifo, \*, timeout=5000)
+
+   Receive data on the bus:
+   
+     - ``fifo`` is an integer, which is the FIFO to receive on
+     - ``timeout`` is the timeout in milliseconds to wait for the receive.
+   
+   Return value: buffer of data bytes.
+
+.. method:: can.send(send, addr, \*, timeout=5000)
+
+   Send a message on the bus:
+   
+     - ``send`` is the data to send (an integer to send, or a buffer object).
+     - ``addr`` is the address to send to
+     - ``timeout`` is the timeout in milliseconds to wait for the send.
+   
+   Return value: ``None``.
+
+Constants
+---------
+
+.. data:: CAN.NORMAL
+.. data:: CAN.LOOPBACK
+.. data:: CAN.SILENT
+.. data:: CAN.SILENT_LOOPBACK
+
+   the mode of the CAN bus
+
+.. data:: CAN.LIST16
+.. data:: CAN.MASK16
+.. data:: CAN.LIST32
+.. data:: CAN.MASK32
+
+	the operation mode of a filter

docs/library/pyb.DAC.rst

@@ -0,0 +1,69 @@
+.. _pyb.DAC:
+
+class DAC -- digital to analog conversion
+=========================================
+
+The DAC is used to output analog values (a specific voltage) on pin X5 or pin X6.
+The voltage will be between 0 and 3.3V.
+
+*This module will undergo changes to the API.*
+
+Example usage::
+
+    from pyb import DAC
+
+    dac = DAC(1)            # create DAC 1 on pin X5
+    dac.write(128)          # write a value to the DAC (makes X5 1.65V)
+
+To output a continuous sine-wave::
+
+    import math
+    from pyb import DAC
+
+    # create a buffer containing a sine-wave
+    buf = bytearray(100)
+    for i in range(len(buf)):
+        buf[i] = 128 + int(127 \* math.sin(2 \* math.pi \* i / len(buf)))
+
+    # output the sine-wave at 400Hz
+    dac = DAC(1)
+    dac.write_timed(buf, 400 \* len(buf), mode=DAC.CIRCULAR)
+
+
+Constructors
+------------
+
+.. class:: pyb.DAC(port)
+
+   Construct a new DAC object.
+   
+   ``port`` can be a pin object, or an integer (1 or 2).
+   DAC(1) is on pin X5 and DAC(2) is on pin X6.
+
+
+Methods
+-------
+
+.. method:: dac.noise(freq)
+
+   Generate a pseudo-random noise signal.  A new random sample is written
+   to the DAC output at the given frequency.
+
+.. method:: dac.triangle(freq)
+
+   Generate a triangle wave.  The value on the DAC output changes at
+   the given frequency, and the frequence of the repeating triangle wave
+   itself is 2048 times smaller.
+
+.. method:: dac.write(value)
+
+   Direct access to the DAC output (8 bit only at the moment).
+
+.. method:: dac.write_timed(data, freq, \*, mode=DAC.NORMAL)
+
+   Initiates a burst of RAM to DAC using a DMA transfer.
+   The input data is treated as an array of bytes (8 bit data).
+   
+   ``mode`` can be ``DAC.NORMAL`` or ``DAC.CIRCULAR``.
+   
+   TIM6 is used to control the frequency of the transfer.

docs/library/pyb.ExtInt.rst

@@ -0,0 +1,113 @@
+.. _pyb.ExtInt:
+
+class ExtInt -- configure I/O pins to interrupt on external events
+==================================================================
+
+There are a total of 22 interrupt lines. 16 of these can come from GPIO pins
+and the remaining 6 are from internal sources.
+
+For lines 0 thru 15, a given line can map to the corresponding line from an
+arbitrary port. So line 0 can map to Px0 where x is A, B, C, ... and
+line 1 can map to Px1 where x is A, B, C, ... ::
+
+    def callback(line):
+        print("line =", line)
+
+Note: ExtInt will automatically configure the gpio line as an input. ::
+
+    extint = pyb.ExtInt(pin, pyb.ExtInt.IRQ_FALLING, pyb.Pin.PULL_UP, callback)
+
+Now every time a falling edge is seen on the X1 pin, the callback will be
+called. Caution: mechanical pushbuttons have "bounce" and pushing or
+releasing a switch will often generate multiple edges.
+See: http://www.eng.utah.edu/~cs5780/debouncing.pdf for a detailed
+explanation, along with various techniques for debouncing.
+
+Trying to register 2 callbacks onto the same pin will throw an exception.
+
+If pin is passed as an integer, then it is assumed to map to one of the
+internal interrupt sources, and must be in the range 16 thru 22.
+
+All other pin objects go through the pin mapper to come up with one of the
+gpio pins. ::
+
+    extint = pyb.ExtInt(pin, mode, pull, callback)
+
+Valid modes are pyb.ExtInt.IRQ_RISING, pyb.ExtInt.IRQ_FALLING,
+pyb.ExtInt.IRQ_RISING_FALLING, pyb.ExtInt.EVT_RISING,
+pyb.ExtInt.EVT_FALLING, and pyb.ExtInt.EVT_RISING_FALLING.
+
+Only the IRQ_xxx modes have been tested. The EVT_xxx modes have
+something to do with sleep mode and the WFE instruction.
+
+Valid pull values are pyb.Pin.PULL_UP, pyb.Pin.PULL_DOWN, pyb.Pin.PULL_NONE.
+
+There is also a C API, so that drivers which require EXTI interrupt lines
+can also use this code. See extint.h for the available functions and
+usrsw.h for an example of using this.
+
+
+Constructors
+------------
+
+.. class:: pyb.ExtInt(pin, mode, pull, callback)
+
+   Create an ExtInt object:
+   
+     - ``pin`` is the pin on which to enable the interrupt (can be a pin object or any valid pin name).
+     - ``mode`` can be one of:
+       - ``ExtInt.IRQ_RISING`` - trigger on a rising edge;
+       - ``ExtInt.IRQ_FALLING`` - trigger on a falling edge;
+       - ``ExtInt.IRQ_RISING_FALLING`` - trigger on a rising or falling edge.
+     - ``pull`` can be one of:
+       - ``pyb.Pin.PULL_NONE`` - no pull up or down resistors;
+       - ``pyb.Pin.PULL_UP`` - enable the pull-up resistor;
+       - ``pyb.Pin.PULL_DOWN`` - enable the pull-down resistor.
+     - ``callback`` is the function to call when the interrupt triggers.  The
+       callback function must accept exactly 1 argument, which is the line that
+       triggered the interrupt.
+
+
+Class methods
+-------------
+
+.. method:: ExtInt.regs()
+
+   Dump the values of the EXTI registers.
+
+
+Methods
+-------
+
+.. method:: extint.disable()
+
+   Disable the interrupt associated with the ExtInt object.
+   This could be useful for debouncing.
+
+.. method:: extint.enable()
+
+   Enable a disabled interrupt.
+
+.. method:: extint.line()
+
+   Return the line number that the pin is mapped to.
+
+.. method:: extint.swint()
+
+   Trigger the callback from software.
+
+
+Constants
+---------
+
+.. data:: ExtInt.IRQ_FALLING
+
+   interrupt on a falling edge
+
+.. data:: ExtInt.IRQ_RISING
+
+   interrupt on a rising edge
+
+.. data:: ExtInt.IRQ_RISING_FALLING
+
+   interrupt on a rising or falling edge

docs/library/pyb.I2C.rst

@@ -0,0 +1,153 @@
+.. _pyb.I2C:
+
+class I2C -- a two-wire serial protocol
+=======================================
+
+I2C is a two-wire protocol for communicating between devices.  At the physical
+level it consists of 2 wires: SCL and SDA, the clock and data lines respectively.
+
+I2C objects are created attached to a specific bus.  They can be initialised
+when created, or initialised later on::
+
+    from pyb import I2C
+
+    i2c = I2C(1)                         # create on bus 1
+    i2c = I2C(1, I2C.MASTER)             # create and init as a master
+    i2c.init(I2C.MASTER, baudrate=20000) # init as a master
+    i2c.init(I2C.SLAVE, addr=0x42)       # init as a slave with given address
+    i2c.deinit()                         # turn off the peripheral
+
+Printing the i2c object gives you information about its configuration.
+
+Basic methods for slave are send and recv::
+
+    i2c.send('abc')      # send 3 bytes
+    i2c.send(0x42)       # send a single byte, given by the number
+    data = i2c.recv(3)   # receive 3 bytes
+
+To receive inplace, first create a bytearray::
+
+    data = bytearray(3)  # create a buffer
+    i2c.recv(data)       # receive 3 bytes, writing them into data
+
+You can specify a timeout (in ms)::
+
+    i2c.send(b'123', timeout=2000)   # timout after 2 seconds
+
+A master must specify the recipient's address::
+
+    i2c.init(I2C.MASTER)
+    i2c.send('123', 0x42)        # send 3 bytes to slave with address 0x42
+    i2c.send(b'456', addr=0x42)  # keyword for address
+
+Master also has other methods::
+
+    i2c.is_ready(0x42)           # check if slave 0x42 is ready
+    i2c.scan()                   # scan for slaves on the bus, returning
+                                 #   a list of valid addresses
+    i2c.mem_read(3, 0x42, 2)     # read 3 bytes from memory of slave 0x42,
+                                 #   starting at address 2 in the slave
+    i2c.mem_write('abc', 0x42, 2, timeout=1000)
+
+
+Constructors
+------------
+
+.. class:: pyb.I2C(bus, ...)
+
+   Construct an I2C object on the given bus.  ``bus`` can be 1 or 2.
+   With no additional parameters, the I2C object is created but not
+   initialised (it has the settings from the last initialisation of
+   the bus, if any).  If extra arguments are given, the bus is initialised.
+   See ``init`` for parameters of initialisation.
+   
+   The physical pins of the I2C busses are:
+   
+     - ``I2C(1)`` is on the X position: ``(SCL, SDA) = (X9, X10) = (PB6, PB7)``
+     - ``I2C(2)`` is on the Y position: ``(SCL, SDA) = (Y9, Y10) = (PB10, PB11)``
+
+
+Methods
+-------
+
+.. method:: i2c.deinit()
+
+   Turn off the I2C bus.
+
+.. method:: i2c.init(mode, \*, addr=0x12, baudrate=400000, gencall=False)
+
+   Initialise the I2C bus with the given parameters:
+   
+     - ``mode`` must be either ``I2C.MASTER`` or ``I2C.SLAVE``
+     - ``addr`` is the 7-bit address (only sensible for a slave)
+     - ``baudrate`` is the SCL clock rate (only sensible for a master)
+     - ``gencall`` is whether to support general call mode
+
+.. method:: i2c.is_ready(addr)
+
+   Check if an I2C device responds to the given address.  Only valid when in master mode.
+
+.. method:: i2c.mem_read(data, addr, memaddr, timeout=5000, addr_size=8)
+
+   Read from the memory of an I2C device:
+   
+     - ``data`` can be an integer (number of bytes to read) or a buffer to read into
+     - ``addr`` is the I2C device address
+     - ``memaddr`` is the memory location within the I2C device
+     - ``timeout`` is the timeout in milliseconds to wait for the read
+     - ``addr_size`` selects width of memaddr: 8 or 16 bits
+   
+   Returns the read data.
+   This is only valid in master mode.
+
+.. method:: i2c.mem_write(data, addr, memaddr, timeout=5000, addr_size=8)
+
+   Write to the memory of an I2C device:
+   
+     - ``data`` can be an integer or a buffer to write from
+     - ``addr`` is the I2C device address
+     - ``memaddr`` is the memory location within the I2C device
+     - ``timeout`` is the timeout in milliseconds to wait for the write
+     - ``addr_size`` selects width of memaddr: 8 or 16 bits
+   
+   Returns ``None``.
+   This is only valid in master mode.
+
+.. method:: i2c.recv(recv, addr=0x00, timeout=5000)
+
+   Receive data on the bus:
+   
+     - ``recv`` can be an integer, which is the number of bytes to receive,
+       or a mutable buffer, which will be filled with received bytes
+     - ``addr`` is the address to receive from (only required in master mode)
+     - ``timeout`` is the timeout in milliseconds to wait for the receive
+   
+   Return value: if ``recv`` is an integer then a new buffer of the bytes received,
+   otherwise the same buffer that was passed in to ``recv``.
+
+.. method:: i2c.scan()
+
+   Scan all I2C addresses from 0x01 to 0x7f and return a list of those that respond.
+   Only valid when in master mode.
+
+.. method:: i2c.send(send, addr=0x00, timeout=5000)
+
+   Send data on the bus:
+   
+     - ``send`` is the data to send (an integer to send, or a buffer object)
+     - ``addr`` is the address to send to (only required in master mode)
+     - ``timeout`` is the timeout in milliseconds to wait for the send
+   
+   Return value: ``None``.
+
+
+Constants
+---------
+
+.. data:: I2C.MASTER
+
+   for initialising the bus to master mode
+
+.. data:: I2C.SLAVE
+
+   for initialising the bus to slave mode

docs/library/pyb.LCD.rst

@@ -0,0 +1,94 @@
+class LCD -- LCD control for the LCD touch-sensor pyskin
+========================================================
+
+The LCD class is used to control the LCD on the LCD touch-sensor pyskin,
+LCD32MKv1.0.  The LCD is a 128x32 pixel monochrome screen, part NHD-C12832A1Z.
+
+The pyskin must be connected in either the X or Y positions, and then
+an LCD object is made using::
+
+    lcd = pyb.LCD('X')      # if pyskin is in the X position
+    lcd = pyb.LCD('Y')      # if pyskin is in the Y position
+
+Then you can use::
+
+    lcd.light(True)                 # turn the backlight on
+    lcd.write('Hello world!\n')     # print text to the screen
+
+This driver implements a double buffer for setting/getting pixels.
+For example, to make a bouncing dot, try::
+
+    x = y = 0
+    dx = dy = 1
+    while True:
+        # update the dot's position
+        x += dx
+        y += dy
+
+        # make the dot bounce of the edges of the screen
+        if x <= 0 or x >= 127: dx = -dx
+        if y <= 0 or y >= 31: dy = -dy
+
+        lcd.fill(0)                 # clear the buffer
+        lcd.pixel(x, y, 1)          # draw the dot
+        lcd.show()                  # show the buffer
+        pyb.delay(50)               # pause for 50ms
+
+
+Constructors
+------------
+
+.. class:: pyb.LCD(skin_position)
+
+   Construct an LCD object in the given skin position.  ``skin_position`` can be 'X' or 'Y', and
+   should match the position where the LCD pyskin is plugged in.
+
+
+Methods
+-------
+
+.. method:: lcd.command(instr_data, buf)
+
+   Send an arbitrary command to the LCD.  Pass 0 for ``instr_data`` to send an
+   instruction, otherwise pass 1 to send data.  ``buf`` is a buffer with the
+   instructions/data to send.
+
+.. method:: lcd.contrast(value)
+
+   Set the contrast of the LCD.  Valid values are between 0 and 47.
+
+.. method:: lcd.fill(colour)
+
+   Fill the screen with the given colour (0 or 1 for white or black).
+   
+   This method writes to the hidden buffer.  Use ``show()`` to show the buffer.
+
+.. method:: lcd.get(x, y)
+
+   Get the pixel at the position ``(x, y)``.  Returns 0 or 1.
+   
+   This method reads from the visible buffer.
+
+.. method:: lcd.light(value)
+
+   Turn the backlight on/off.  True or 1 turns it on, False or 0 turns it off.
+
+.. method:: lcd.pixel(x, y, colour)
+
+   Set the pixel at ``(x, y)`` to the given colour (0 or 1).
+   
+   This method writes to the hidden buffer.  Use ``show()`` to show the buffer.
+
+.. method:: lcd.show()
+
+   Show the hidden buffer on the screen.
+
+.. method:: lcd.text(str, x, y, colour)
+
+   Draw the given text to the position ``(x, y)`` using the given colour (0 or 1).
+   
+   This method writes to the hidden buffer.  Use ``show()`` to show the buffer.
+
+.. method:: lcd.write(str)
+
+   Write the string ``str`` to the screen.  It will appear immediately.

docs/library/pyb.LED.rst

@@ -0,0 +1,39 @@
+.. _pyb.LED:
+
+class LED -- LED object
+=======================
+
+The LED object controls an individual LED (Light Emitting Diode).
+
+
+Constructors
+------------
+
+.. class:: pyb.LED(id)
+
+   Create an LED object associated with the given LED:
+   
+     - ``id`` is the LED number, 1-4.
+
+
+Methods
+-------
+
+.. method:: led.intensity([value])
+
+   Get or set the LED intensity.  Intensity ranges between 0 (off) and 255 (full on).
+   If no argument is given, return the LED intensity.
+   If an argument is given, set the LED intensity and return ``None``.
+
+.. method:: led.off()
+
+   Turn the LED off.
+
+.. method:: led.on()
+
+   Turn the LED on, to maximum intensity.
+
+.. method:: led.toggle()
+
+   Toggle the LED between on (maximum intensity) and off.  If the LED is at
+   non-zero intensity then it is considered "on" and toggle will turn it off.

docs/library/pyb.Pin.rst

@@ -0,0 +1,266 @@
+.. _pyb.Pin:
+
+class Pin -- control I/O pins
+=============================
+
+A pin is the basic object to control I/O pins.  It has methods to set
+the mode of the pin (input, output, etc) and methods to get and set the
+digital logic level.  For analog control of a pin, see the ADC class.
+
+Usage Model:
+
+All Board Pins are predefined as pyb.Pin.board.Name ::
+
+    x1_pin = pyb.Pin.board.X1
+
+    g = pyb.Pin(pyb.Pin.board.X1, pyb.Pin.IN)
+
+CPU pins which correspond to the board pins are available
+as ``pyb.cpu.Name``. For the CPU pins, the names are the port letter
+followed by the pin number. On the PYBv1.0, ``pyb.Pin.board.X1`` and
+``pyb.Pin.cpu.B6`` are the same pin.
+
+You can also use strings::
+
+    g = pyb.Pin('X1', pyb.Pin.OUT_PP)
+
+Users can add their own names::
+
+    MyMapperDict = { 'LeftMotorDir' : pyb.Pin.cpu.C12 }
+    pyb.Pin.dict(MyMapperDict)
+    g = pyb.Pin("LeftMotorDir", pyb.Pin.OUT_OD)
+
+and can query mappings ::
+
+    pin = pyb.Pin("LeftMotorDir")
+
+Users can also add their own mapping function::
+
+    def MyMapper(pin_name):
+       if pin_name == "LeftMotorDir":
+           return pyb.Pin.cpu.A0
+
+    pyb.Pin.mapper(MyMapper)
+
+So, if you were to call: ``pyb.Pin("LeftMotorDir", pyb.Pin.OUT_PP)``
+then ``"LeftMotorDir"`` is passed directly to the mapper function.
+
+To summarise, the following order determines how things get mapped into
+an ordinal pin number:
+
+1. Directly specify a pin object
+2. User supplied mapping function
+3. User supplied mapping (object must be usable as a dictionary key)
+4. Supply a string which matches a board pin
+5. Supply a string which matches a CPU port/pin
+
+You can set ``pyb.Pin.debug(True)`` to get some debug information about
+how a particular object gets mapped to a pin.
+
+When a pin has the ``Pin.PULL_UP`` or ``Pin.PULL_DOWN`` pull-mode enabled,
+that pin has an effective 40k Ohm resistor pulling it to 3V3 or GND
+respectively (except pin Y5 which has 11k Ohm resistors).
+
+Constructors
+------------
+
+.. class:: pyb.Pin(id, ...)
+
+   Create a new Pin object associated with the id.  If additional arguments are given,
+   they are used to initialise the pin.  See :meth:`pin.init`.
+
+
+Class methods
+-------------
+
+.. method:: Pin.af_list()
+
+   Returns an array of alternate functions available for this pin.
+
+.. method:: Pin.debug([state])
+
+   Get or set the debugging state (``True`` or ``False`` for on or off).
+
+.. method:: Pin.dict([dict])
+
+   Get or set the pin mapper dictionary.
+
+.. method:: Pin.mapper([fun])
+
+   Get or set the pin mapper function.
+
+
+Methods
+-------
+
+.. method:: pin.init(mode, pull=Pin.PULL_NONE, af=-1)
+
+   Initialise the pin:
+   
+     - ``mode`` can be one of:
+       - ``Pin.IN`` - configure the pin for input;
+       - ``Pin.OUT_PP`` - configure the pin for output, with push-pull control;
+       - ``Pin.OUT_OD`` - configure the pin for output, with open-drain control;
+       - ``Pin.AF_PP`` - configure the pin for alternate function, pull-pull;
+       - ``Pin.AF_OD`` - configure the pin for alternate function, open-drain;
+       - ``Pin.ANALOG`` - configure the pin for analog.
+     - ``pull`` can be one of:
+       - ``Pin.PULL_NONE`` - no pull up or down resistors;
+       - ``Pin.PULL_UP`` - enable the pull-up resistor;
+       - ``Pin.PULL_DOWN`` - enable the pull-down resistor.
+     - when mode is Pin.AF_PP or Pin.AF_OD, then af can be the index or name
+       of one of the alternate functions associated with a pin.
+   
+   Returns: ``None``.
+
+.. method:: pin.high()
+
+   Set the pin to a high logic level.
+
+.. method:: pin.low()
+
+   Set the pin to a low logic level.
+
+.. method:: pin.value([value])
+
+   Get or set the digital logic level of the pin:
+
+     - With no argument, return 0 or 1 depending on the logic level of the pin.
+     - With ``value`` given, set the logic level of the pin.  ``value`` can be
+       anything that converts to a boolean.  If it converts to ``True``, the pin
+       is set high, otherwise it is set low.
+
+.. method:: pin.__str__()
+
+   Return a string describing the pin object.
+
+.. method:: pin.af()
+
+   Returns the currently configured alternate-function of the pin. The
+   integer returned will match one of the allowed constants for the af
+   argument to the init function.
+
+.. method:: pin.gpio()
+
+   Returns the base address of the GPIO block associated with this pin.
+
+.. method:: pin.mode()
+
+   Returns the currently configured mode of the pin. The integer returned
+   will match one of the allowed constants for the mode argument to the init
+   function.
+
+.. method:: pin.name()
+
+   Get the pin name.
+
+.. method:: pin.names()
+
+   Returns the cpu and board names for this pin.
+
+.. method:: pin.pin()
+
+   Get the pin number.
+
+.. method:: pin.port()
+
+   Get the pin port.
+
+.. method:: pin.pull()
+
+   Returns the currently configured pull of the pin. The integer returned
+   will match one of the allowed constants for the pull argument to the init
+   function.
+
+
+Constants
+---------
+
+.. data:: Pin.AF_OD
+
+   initialise the pin to alternate-function mode with an open-drain drive
+
+.. data:: Pin.AF_PP
+
+   initialise the pin to alternate-function mode with a push-pull drive
+
+.. data:: Pin.ANALOG
+
+   initialise the pin to analog mode
+
+.. data:: Pin.IN
+
+   initialise the pin to input mode
+
+.. data:: Pin.OUT_OD
+
+   initialise the pin to output mode with an open-drain drive
+
+.. data:: Pin.OUT_PP
+
+   initialise the pin to output mode with a push-pull drive
+
+.. data:: Pin.PULL_DOWN
+
+   enable the pull-down resistor on the pin
+
+.. data:: Pin.PULL_NONE
+
+   don't enable any pull up or down resistors on the pin
+
+.. data:: Pin.PULL_UP
+
+   enable the pull-up resistor on the pin
+
+
+class PinAF -- Pin Alternate Functions
+======================================
+
+A Pin represents a physical pin on the microcprocessor. Each pin
+can have a variety of functions (GPIO, I2C SDA, etc). Each PinAF
+object represents a particular function for a pin.
+
+Usage Model::
+
+    x3 = pyb.Pin.board.X3
+    x3_af = x3.af_list()
+
+x3_af will now contain an array of PinAF objects which are availble on
+pin X3.
+
+For the pyboard, x3_af would contain:
+    [Pin.AF1_TIM2, Pin.AF2_TIM5, Pin.AF3_TIM9, Pin.AF7_USART2]
+
+Normally, each peripheral would configure the af automatically, but sometimes
+the same function is available on multiple pins, and having more control
+is desired.
+
+To configure X3 to expose TIM2_CH3, you could use::
+
+   pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=pyb.Pin.AF1_TIM2)
+
+or::
+
+   pin = pyb.Pin(pyb.Pin.board.X3, mode=pyb.Pin.AF_PP, af=1)
+
+
+Methods
+-------
+
+.. method:: pinaf.__str__()
+
+   Return a string describing the alternate function.
+
+.. method:: pinaf.index()
+
+   Return the alternate function index.
+
+.. method:: pinaf.name()
+
+   Return the name of the alternate function.
+
+.. method:: pinaf.reg()
+
+   Return the base register associated with the peripheral assigned to this
+   alternate function. For example, if the alternate function were TIM2_CH3
+   this would return stm.TIM2

docs/library/pyb.RTC.rst

@@ -0,0 +1,48 @@
+class RTC -- real time clock
+============================
+
+The RTC is and independent clock that keeps track of the date
+and time.
+
+Example usage::
+
+    rtc = pyb.RTC()
+    rtc.datetime((2014, 5, 1, 4, 13, 0, 0, 0))
+    print(rtc.datetime())
+
+
+Constructors
+------------
+
+.. class:: pyb.RTC()
+
+   Create an RTC object.
+
+
+Methods
+-------
+
+.. method:: rtc.datetime([datetimetuple])
+
+   Get or set the date and time of the RTC.
+   
+   With no arguments, this method returns an 8-tuple with the current
+   date and time.  With 1 argument (being an 8-tuple) it sets the date
+   and time.
+   
+   The 8-tuple has the following format:
+   
+       (year, month, day, weekday, hours, minutes, seconds, subseconds)
+   
+   ``weekday`` is 1-7 for Monday through Sunday.
+   
+   ``subseconds`` counts down from 255 to 0
+
+.. method:: rtc.info()
+
+   Get information about the startup time and reset source.
+   
+    - The lower 0xffff are the number of milliseconds the RTC took to
+      start up.
+    - Bit 0x10000 is set if a power-on reset occurred.
+    - Bit 0x20000 is set if an external reset occurred

docs/library/pyb.SPI.rst

@@ -0,0 +1,123 @@
+.. _pyb.SPI:
+
+class SPI -- a master-driven serial protocol
+============================================
+
+SPI is a serial protocol that is driven by a master.  At the physical level
+there are 3 lines: SCK, MOSI, MISO.
+
+See usage model of I2C; SPI is very similar.  Main difference is
+parameters to init the SPI bus::
+
+    from pyb import SPI
+    spi = SPI(1, SPI.MASTER, baudrate=600000, polarity=1, phase=0, crc=0x7)
+
+Only required parameter is mode, SPI.MASTER or SPI.SLAVE.  Polarity can be
+0 or 1, and is the level the idle clock line sits at.  Phase can be 0 or 1
+to sample data on the first or second clock edge respectively.  Crc can be
+None for no CRC, or a polynomial specifier.
+
+Additional method for SPI::
+
+    data = spi.send_recv(b'1234')        # send 4 bytes and receive 4 bytes
+    buf = bytearray(4)
+    spi.send_recv(b'1234', buf)          # send 4 bytes and receive 4 into buf
+    spi.send_recv(buf, buf)              # send/recv 4 bytes from/to buf
+
+
+Constructors
+------------
+
+.. class:: pyb.SPI(bus, ...)
+
+   Construct an SPI object on the given bus.  ``bus`` can be 1 or 2.
+   With no additional parameters, the SPI object is created but not
+   initialised (it has the settings from the last initialisation of
+   the bus, if any).  If extra arguments are given, the bus is initialised.
+   See ``init`` for parameters of initialisation.
+   
+   The physical pins of the SPI busses are:
+   
+     - ``SPI(1)`` is on the X position: ``(NSS, SCK, MISO, MOSI) = (X5, X6, X7, X8) = (PA4, PA5, PA6, PA7)``
+     - ``SPI(2)`` is on the Y position: ``(NSS, SCK, MISO, MOSI) = (Y5, Y6, Y7, Y8) = (PB12, PB13, PB14, PB15)``
+   
+   At the moment, the NSS pin is not used by the SPI driver and is free
+   for other use.
+
+
+Methods
+-------
+
+.. method:: spi.deinit()
+
+   Turn off the SPI bus.
+
+.. method:: spi.init(mode, baudrate=328125, \*, prescaler, polarity=1, phase=0, bits=8, firstbit=SPI.MSB, ti=False, crc=None)
+
+   Initialise the SPI bus with the given parameters:
+   
+     - ``mode`` must be either ``SPI.MASTER`` or ``SPI.SLAVE``.
+     - ``baudrate`` is the SCK clock rate (only sensible for a master).
+     - ``prescaler`` is the prescaler to use to derive SCK from the APB bus frequency;
+       use of ``prescaler`` overrides ``baudrate``.
+     - ``polarity`` can be 0 or 1, and is the level the idle clock line sits at.
+     - ``phase`` can be 0 or 1 to sample data on the first or second clock edge
+       respectively.
+     - ``firstbit`` can be ``SPI.MSB`` or ``SPI.LSB``.
+     - ``crc`` can be None for no CRC, or a polynomial specifier.
+
+   Note that the SPI clock frequency will not always be the requested baudrate.
+   The hardware only supports baudrates that are the APB bus frequency
+   (see :meth:`pyb.freq`) divided by a prescaler, which can be 2, 4, 8, 16, 32,
+   64, 128 or 256.  SPI(1) is on AHB2, and SPI(2) is on AHB1.  For precise
+   control over the SPI clock frequency, specify ``prescaler`` instead of
+   ``baudrate``.
+
+   Printing the SPI object will show you the computed baudrate and the chosen
+   prescaler.
+
+.. method:: spi.recv(recv, \*, timeout=5000)
+
+   Receive data on the bus:
+   
+     - ``recv`` can be an integer, which is the number of bytes to receive,
+       or a mutable buffer, which will be filled with received bytes.
+     - ``timeout`` is the timeout in milliseconds to wait for the receive.
+   
+   Return value: if ``recv`` is an integer then a new buffer of the bytes received,
+   otherwise the same buffer that was passed in to ``recv``.
+
+.. method:: spi.send(send, \*, timeout=5000)
+
+   Send data on the bus:
+   
+     - ``send`` is the data to send (an integer to send, or a buffer object).
+     - ``timeout`` is the timeout in milliseconds to wait for the send.
+   
+   Return value: ``None``.
+
+.. method:: spi.send_recv(send, recv=None, \*, timeout=5000)
+
+   Send and receive data on the bus at the same time:
+   
+     - ``send`` is the data to send (an integer to send, or a buffer object).
+     - ``recv`` is a mutable buffer which will be filled with received bytes.
+       It can be the same as ``send``, or omitted.  If omitted, a new buffer will
+       be created.
+     - ``timeout`` is the timeout in milliseconds to wait for the receive.
+   
+   Return value: the buffer with the received bytes.
+
+
+Constants
+---------
+
+.. data:: SPI.MASTER
+.. data:: SPI.SLAVE
+
+   for initialising the SPI bus to master or slave mode
+
+.. data:: SPI.LSB
+.. data:: SPI.MSB
+
+   set the first bit to be the least or most significant bit

docs/library/pyb.Servo.rst

@@ -0,0 +1,79 @@
+.. _pyb.Servo:
+
+class Servo -- 3-wire hobby servo driver
+========================================
+
+Servo objects control standard hobby servo motors with 3-wires (ground, power,
+signal).  There are 4 positions on the pyboard where these motors can be plugged
+in: pins X1 through X4 are the signal pins, and next to them are 4 sets of power
+and ground pins.
+
+Example usage::
+
+    import pyb
+
+    s1 = pyb.Servo(1)   # create a servo object on position X1
+    s2 = pyb.Servo(2)   # create a servo object on position X2
+
+    s1.angle(45)        # move servo 1 to 45 degrees
+    s2.angle(0)         # move servo 2 to 0 degrees
+
+    # move servo1 and servo2 synchronously, taking 1500ms
+    s1.angle(-60, 1500)
+    s2.angle(30, 1500)
+
+.. note:: The Servo objects use Timer(5) to produce the PWM output.  You can
+   use Timer(5) for Servo control, or your own purposes, but not both at the
+   same time.
+
+Constructors
+------------
+
+.. class:: pyb.Servo(id)
+
+   Create a servo object.  ``id`` is 1-4, and corresponds to pins X1 through X4.
+
+
+Methods
+-------
+
+.. method:: servo.angle([angle, time=0])
+
+   If no arguments are given, this function returns the current angle.
+
+   If arguments are given, this function sets the angle of the servo:
+
+     - ``angle`` is the angle to move to in degrees.
+     - ``time`` is the number of milliseconds to take to get to the specified
+       angle.  If omitted, then the servo moves as quickly as possible to its
+       new position.
+
+.. method:: servo.speed([speed, time=0])
+
+   If no arguments are given, this function returns the current speed.
+
+   If arguments are given, this function sets the speed of the servo:
+
+     - ``speed`` is the speed to change to, between -100 and 100.
+     - ``time`` is the number of milliseconds to take to get to the specified
+       speed.  If omitted, then the servo accelerates as quickly as possible.
+
+.. method:: servo.pulse_width([value])
+
+   If no arguments are given, this function returns the current raw pulse-width
+   value.
+
+   If an argument is given, this function sets the raw pulse-width value.
+
+.. method:: servo.calibration([pulse_min, pulse_max, pulse_centre, [pulse_angle_90, pulse_speed_100]])
+
+   If no arguments are given, this function returns the current calibration
+   data, as a 5-tuple.
+
+   If arguments are given, this function sets the timing calibration:
+
+     - ``pulse_min`` is the minimum allowed pulse width.
+     - ``pulse_max`` is the maximum allowed pulse width.
+     - ``pulse_centre`` is the pulse width corresponding to the centre/zero position.
+     - ``pulse_angle_90`` is the pulse width corresponding to 90 degrees.
+     - ``pulse_speed_100`` is the pulse width corresponding to a speed of 100.

docs/library/pyb.Switch.rst

@@ -0,0 +1,37 @@
+class Switch -- switch object
+=============================
+
+A Switch object is used to control a push-button switch.
+
+Usage::
+
+     sw = pyb.Switch()       # create a switch object
+     sw()                    # get state (True if pressed, False otherwise)
+     sw.callback(f)          # register a callback to be called when the
+                             #   switch is pressed down
+     sw.callback(None)       # remove the callback
+
+Example::
+
+     pyb.Switch().callback(lambda: pyb.LED(1).toggle())
+
+
+Constructors
+------------
+
+.. class:: pyb.Switch()
+
+   Create and return a switch object.
+
+
+Methods
+-------
+
+.. method:: switch()
+
+   Return the switch state: ``True`` if pressed down, ``False`` otherwise.
+
+.. method:: switch.callback(fun)
+
+   Register the given function to be called when the switch is pressed down.
+   If ``fun`` is ``None``, then it disables the callback.

docs/library/pyb.Timer.rst

@@ -0,0 +1,234 @@
+.. _pyb.Timer:
+
+class Timer -- control internal timers
+======================================
+
+Timers can be used for a great variety of tasks.  At the moment, only
+the simplest case is implemented: that of calling a function periodically.
+
+Each timer consists of a counter that counts up at a certain rate.  The rate
+at which it counts is the peripheral clock frequency (in Hz) divided by the
+timer prescaler.  When the counter reaches the timer period it triggers an
+event, and the counter resets back to zero.  By using the callback method,
+the timer event can call a Python function.
+
+Example usage to toggle an LED at a fixed frequency::
+
+    tim = pyb.Timer(4)              # create a timer object using timer 4
+    tim.init(freq=2)                # trigger at 2Hz
+    tim.callback(lambda t:pyb.LED(1).toggle())
+
+Further examples::
+
+    tim = pyb.Timer(4, freq=100)    # freq in Hz
+    tim = pyb.Timer(4, prescaler=0, period=99)
+    tim.counter()                   # get counter (can also set)
+    tim.prescaler(2)                # set prescaler (can also get)
+    tim.period(199)                 # set period (can also get)
+    tim.callback(lambda t: ...)     # set callback for update interrupt (t=tim instance)
+    tim.callback(None)              # clear callback
+
+*Note:* Timer 3 is reserved for internal use.  Timer 5 controls
+the servo driver, and Timer 6 is used for timed ADC/DAC reading/writing.
+It is recommended to use the other timers in your programs.
+
+
+Constructors
+------------
+
+.. class:: pyb.Timer(id, ...)
+
+   Construct a new timer object of the given id.  If additional
+   arguments are given, then the timer is initialised by ``init(...)``.
+   ``id`` can be 1 to 14, excluding 3.
+
+
+Methods
+-------
+
+.. method:: timer.callback(fun)
+
+   Set the function to be called when the timer triggers.
+   ``fun`` is passed 1 argument, the timer object.
+   If ``fun`` is ``None`` then the callback will be disabled.
+
+.. method:: timer.channel(channel, mode, ...)
+
+   If only a channel number is passed, then a previously initialized channel
+   object is returned (or ``None`` if there is no previous channel).
+   
+   Othwerwise, a TimerChannel object is initialized and returned.
+   
+   Each channel can be configured to perform pwm, output compare, or
+   input capture. All channels share the same underlying timer, which means
+   that they share the same timer clock.
+   
+   Keyword arguments:
+   
+     - ``mode`` can be one of:
+
+       - ``Timer.PWM`` --- configure the timer in PWM mode (active high).
+       - ``Timer.PWM_INVERTED`` --- configure the timer in PWM mode (active low).
+       - ``Timer.OC_TIMING`` --- indicates that no pin is driven.
+       - ``Timer.OC_ACTIVE`` --- the pin will be made active when a compare match occurs (active is determined by polarity)
+       - ``Timer.OC_INACTIVE`` --- the pin will be made inactive when a compare match occurs.
+       - ``Timer.OC_TOGGLE`` --- the pin will be toggled when an compare match occurs.
+       - ``Timer.OC_FORCED_ACTIVE`` --- the pin is forced active (compare match is ignored).
+       - ``Timer.OC_FORCED_INACTIVE`` --- the pin is forced inactive (compare match is ignored).
+       - ``Timer.IC`` --- configure the timer in Input Capture mode.
+   
+     - ``callback`` - as per TimerChannel.callback()
+   
+     - ``pin`` None (the default) or a Pin object. If specified (and not None)
+       this will cause the alternate function of the the indicated pin
+       to be configured for this timer channel. An error will be raised if
+       the pin doesn't support any alternate functions for this timer channel.
+   
+   Keyword arguments for Timer.PWM modes:
+   
+     - ``pulse_width`` - determines the initial pulse width value to use.
+     - ``pulse_width_percent`` - determines the initial pulse width percentage to use.
+   
+   Keyword arguments for Timer.OC modes:
+   
+     - ``compare`` - determines the initial value of the compare register.
+   
+     - ``polarity`` can be one of:
+       - ``Timer.HIGH`` - output is active high
+       - ``Timer.LOW`` - output is acive low
+   
+   Optional keyword arguments for Timer.IC modes:
+   
+     - ``polarity`` can be one of:
+       - ``Timer.RISING`` - captures on rising edge.
+       - ``Timer.FALLING`` - captures on falling edge.
+       - ``Timer.BOTH`` - captures on both edges.
+   
+     Note that capture only works on the primary channel, and not on the
+     complimentary channels.
+   
+   PWM Example::
+   
+       timer = pyb.Timer(2, freq=1000)
+       ch2 = timer.channel(2, pyb.Timer.PWM, pin=pyb.Pin.board.X2, pulse_width=210000)
+       ch3 = timer.channel(3, pyb.Timer.PWM, pin=pyb.Pin.board.X3, pulse_width=420000)
+
+.. method:: timer.counter([value])
+
+   Get or set the timer counter.
+
+.. method:: timer.deinit()
+
+   Deinitialises the timer.
+   
+   Disables the callback (and the associated irq).
+   Disables any channel callbacks (and the associated irq).
+   Stops the timer, and disables the timer peripheral.
+
+.. method:: timer.freq([value])
+
+   Get or set the frequency for the timer (changes prescaler and period if set).
+
+.. method:: timer.init(\*, freq, prescaler, period)
+
+   Initialise the timer.  Initialisation must be either by frequency (in Hz)
+   or by prescaler and period::
+   
+       tim.init(freq=100)                  # set the timer to trigger at 100Hz
+       tim.init(prescaler=83, period=999)  # set the prescaler and period directly
+   
+   Keyword arguments:
+   
+     - ``freq`` --- specifies the periodic frequency of the timer. You migh also
+       view this as the frequency with which the timer goes through one complete cycle.
+   
+     - ``prescaler`` [0-0xffff] - specifies the value to be loaded into the
+       timer's Prescaler Register (PSC). The timer clock source is divided by
+       (``prescaler + 1``) to arrive at the timer clock. Timers 2-7 and 12-14
+       have a clock source of 84 MHz (pyb.freq()[2] \* 2), and Timers 1, and 8-11
+       have a clock source of 168 MHz (pyb.freq()[3] \* 2).
+   
+     - ``period`` [0-0xffff] for timers 1, 3, 4, and 6-15. [0-0x3fffffff] for timers 2 & 5.
+       Specifies the value to be loaded into the timer's AutoReload
+       Register (ARR). This determines the period of the timer (i.e. when the
+       counter cycles). The timer counter will roll-over after ``period + 1``
+       timer clock cycles.
+   
+     - ``mode`` can be one of:
+
+       - ``Timer.UP`` - configures the timer to count from 0 to ARR (default)
+       - ``Timer.DOWN`` - configures the timer to count from ARR down to 0.
+       - ``Timer.CENTER`` - confgures the timer to count from 0 to ARR and
+         then back down to 0.
+   
+     - ``div`` can be one of 1, 2, or 4. Divides the timer clock to determine
+       the sampling clock used by the digital filters.
+   
+     - ``callback`` - as per Timer.callback()
+   
+     - ``deadtime`` - specifies the amount of "dead" or inactive time between
+       transitions on complimentary channels (both channels will be inactive)
+       for this time). ``deadtime`` may be an integer between 0 and 1008, with
+       the following restrictions: 0-128 in steps of 1. 128-256 in steps of
+       2, 256-512 in steps of 8, and 512-1008 in steps of 16. ``deadime``
+       measures ticks of ``source_freq`` divided by ``div`` clock ticks.
+       ``deadtime`` is only available on timers 1 and 8.
+   
+    You must either specify freq or both of period and prescaler.
+
+.. method:: timer.period([value])
+
+   Get or set the period of the timer.
+
+.. method:: timer.prescaler([value])
+
+   Get or set the prescaler for the timer.
+
+.. method:: timer.source_freq()
+
+   Get the frequency of the source of the timer.
+
+class TimerChannel --- setup a channel for a timer
+==================================================
+
+Timer channels are used to generate/capture a signal using a timer.
+
+TimerChannel objects are created using the Timer.channel() method.
+
+Methods
+-------
+
+.. method:: timerchannel.callback(fun)
+
+   Set the function to be called when the timer channel triggers.
+   ``fun`` is passed 1 argument, the timer object.
+   If ``fun`` is ``None`` then the callback will be disabled.
+
+.. method:: timerchannel.capture([value])
+
+   Get or set the capture value associated with a channel.
+   capture, compare, and pulse_width are all aliases for the same function.
+   capture is the logical name to use when the channel is in input capture mode.
+
+.. method:: timerchannel.compare([value])
+
+   Get or set the compare value associated with a channel.
+   capture, compare, and pulse_width are all aliases for the same function.
+   compare is the logical name to use when the channel is in output compare mode.
+
+.. method:: timerchannel.pulse_width([value])
+
+   Get or set the pulse width value associated with a channel.
+   capture, compare, and pulse_width are all aliases for the same function.
+   pulse_width is the logical name to use when the channel is in PWM mode.
+   
+   In edge aligned mode, a pulse_width of ``period + 1`` corresponds to a duty cycle of 100%
+   In center aligned mode, a pulse width of ``period`` corresponds to a duty cycle of 100%
+
+.. method:: timerchannel.pulse_width_percent([value])
+
+   Get or set the pulse width percentage associated with a channel.  The value
+   is a number between 0 and 100 and sets the percentage of the timer period
+   for which the pulse is active.  The value can be an integer or
+   floating-point number for more accuracy.  For example, a value of 25 gives
+   a duty cycle of 25%.

docs/library/pyb.UART.rst

@@ -0,0 +1,136 @@
+.. _pyb.UART:
+
+class UART -- duplex serial communication bus
+=============================================
+
+UART implements the standard UART/USART duplex serial communications protocol.  At
+the physical level it consists of 2 lines: RX and TX.  The unit of communication
+is a character (not to be confused with a string character) which can be 8 or 9
+bits wide.
+
+UART objects can be created and initialised using::
+
+    from pyb import UART
+
+    uart = UART(1, 9600)                         # init with given baudrate
+    uart.init(9600, bits=8, parity=None, stop=1) # init with given parameters
+
+Bits can be 7, 8 or 9.  Parity can be None, 0 (even) or 1 (odd).  Stop can be 1 or 2.
+
+*Note:* with parity=None, only 8 and 9 bits are supported.  With parity enabled,
+only 7 and 8 bits are supported.
+
+A UART object acts like a stream object and reading and writing is done
+using the standard stream methods::
+
+    uart.read(10)       # read 10 characters, returns a bytes object
+    uart.readall()      # read all available characters
+    uart.readline()     # read a line
+    uart.readinto(buf)  # read and store into the given buffer
+    uart.write('abc')   # write the 3 characters
+
+Individual characters can be read/written using::
+
+    uart.readchar()     # read 1 character and returns it as an integer
+    uart.writechar(42)  # write 1 character
+
+To check if there is anything to be read, use::
+
+    uart.any()               # returns True if any characters waiting
+
+*Note:* The stream functions ``read``, ``write`` etc Are new in Micro Python since v1.3.4.
+Earlier versions use ``uart.send`` and ``uart.recv``.
+
+Constructors
+------------
+
+.. class:: pyb.UART(bus, ...)
+
+   Construct a UART object on the given bus.  ``bus`` can be 1-6, or 'XA', 'XB', 'YA', or 'YB'.
+   With no additional parameters, the UART object is created but not
+   initialised (it has the settings from the last initialisation of
+   the bus, if any).  If extra arguments are given, the bus is initialised.
+   See ``init`` for parameters of initialisation.
+
+   The physical pins of the UART busses are:
+
+     - ``UART(4)`` is on ``XA``: ``(TX, RX) = (X1, X2) = (PA0, PA1)``
+     - ``UART(1)`` is on ``XB``: ``(TX, RX) = (X9, X10) = (PB6, PB7)``
+     - ``UART(6)`` is on ``YA``: ``(TX, RX) = (Y1, Y2) = (PC6, PC7)``
+     - ``UART(3)`` is on ``YB``: ``(TX, RX) = (Y9, Y10) = (PB10, PB11)``
+     - ``UART(2)`` is on: ``(TX, RX) = (X3, X4) = (PA2, PA3)``
+
+Methods
+-------
+
+.. method:: uart.init(baudrate, bits=8, parity=None, stop=1, \*, timeout=1000, timeout_char=0, read_buf_len=64)
+
+   Initialise the UART bus with the given parameters:
+
+     - ``baudrate`` is the clock rate.
+     - ``bits`` is the number of bits per character, 7, 8 or 9.
+     - ``parity`` is the parity, ``None``, 0 (even) or 1 (odd).
+     - ``stop`` is the number of stop bits, 1 or 2.
+     - ``timeout`` is the timeout in milliseconds to wait for the first character.
+     - ``timeout_char`` is the timeout in milliseconds to wait between characters.
+     - ``read_buf_len`` is the character length of the read buffer (0 to disable).
+
+   *Note:* with parity=None, only 8 and 9 bits are supported.  With parity enabled,
+   only 7 and 8 bits are supported.
+
+.. method:: uart.deinit()
+
+   Turn off the UART bus.
+
+.. method:: uart.any()
+
+   Return ``True`` if any characters waiting, else ``False``.
+
+.. method:: uart.read([nbytes])
+
+   Read characters.  If ``nbytes`` is specified then read at most that many bytes.
+
+   *Note:* for 9 bit characters each character takes two bytes, ``nbytes`` must
+   be even, and the number of characters is ``nbytes/2``.
+
+   Return value: a bytes object containing the bytes read in.  Returns ``b''``
+   on timeout.
+
+.. method:: uart.readall()
+
+   Read as much data as possible.
+
+   Return value: a bytes object.
+
+.. method:: uart.readchar()
+
+   Receive a single character on the bus.
+
+   Return value: The character read, as an integer.  Returns -1 on timeout.
+
+.. method:: uart.readinto(buf[, nbytes])
+
+   Read bytes into the ``buf``.  If ``nbytes`` is specified then read at most
+   that many bytes.  Otherwise, read at most ``len(buf)`` bytes.
+
+   Return value: number of bytes read and stored into ``buf``.
+
+.. method:: uart.readline()
+
+   Read a line, ending in a newline character.
+
+   Return value: the line read.
+
+.. method:: uart.write(buf)
+
+   Write the buffer of bytes to the bus.  If characters are 7 or 8 bits wide
+   then each byte is one character.  If characters are 9 bits wide then two
+   bytes are used for each character (little endian), and ``buf`` must contain
+   an even number of bytes.
+
+   Return value: number of bytes written.
+
+.. method:: uart.writechar(char)
+
+   Write a single character on the bus.  ``char`` is an integer to write.
+   Return value: ``None``.

docs/library/pyb.USB_VCP.rst

@@ -0,0 +1,66 @@
+class USB_VCP -- USB virtual comm port
+======================================
+
+The USB_VCP class allows creation of an object representing the USB
+virtual comm port.  It can be used to read and write data over USB to
+the connected host.
+
+
+Constructors
+------------
+
+.. class:: pyb.USB_VCP()
+
+   Create a new USB_VCP object.
+
+
+Methods
+-------
+
+.. method:: usb_vcp.setinterrupt(chr)
+
+   Set the character which interrupts running Python code.  This is set
+   to 3 (CTRL-C) by default, and when a CTRL-C character is received over
+   the USB VCP port, a KeyboardInterrupt exception is raised.
+
+   Set to -1 to disable this interrupt feature.  This is useful when you
+   want to send raw bytes over the USB VCP port.
+
+.. method:: usb_vcp.any()
+
+   Return ``True`` if any characters waiting, else ``False``.
+
+.. method:: usb_vcp.close()
+
+
+.. method:: usb_vcp.read([nbytes])
+
+
+.. method:: usb_vcp.readall()
+
+
+.. method:: usb_vcp.readline()
+
+
+.. method:: usb_vcp.recv(data, \*, timeout=5000)
+
+   Receive data on the bus:
+   
+     - ``data`` can be an integer, which is the number of bytes to receive,
+       or a mutable buffer, which will be filled with received bytes.
+     - ``timeout`` is the timeout in milliseconds to wait for the receive.
+   
+   Return value: if ``data`` is an integer then a new buffer of the bytes received,
+   otherwise the number of bytes read into ``data`` is returned.
+
+.. method:: usb_vcp.send(data, \*, timeout=5000)
+
+   Send data over the USB VCP:
+   
+     - ``data`` is the data to send (an integer to send, or a buffer object).
+     - ``timeout`` is the timeout in milliseconds to wait for the send.
+   
+   Return value: number of bytes sent.
+
+.. method:: usb_vcp.write(buf)
+

docs/library/pyb.rst

@@ -0,0 +1,229 @@
+:mod:`pyb` --- functions related to the pyboard
+===============================================
+
+.. module:: pyb
+   :synopsis: functions related to the pyboard
+
+The ``pyb`` module contains specific functions related to the pyboard.
+
+Time related functions
+----------------------
+
+.. function:: delay(ms)
+
+   Delay for the given number of milliseconds.
+
+.. function:: udelay(us)
+
+   Delay for the given number of microseconds.
+
+.. function:: millis()
+
+   Returns the number of milliseconds since the board was last reset.
+   
+   The result is always a micropython smallint (31-bit signed number), so
+   after 2^30 milliseconds (about 12.4 days) this will start to return
+   negative numbers.
+
+.. function:: micros()
+
+   Returns the number of microseconds since the board was last reset.
+   
+   The result is always a micropython smallint (31-bit signed number), so
+   after 2^30 microseconds (about 17.8 minutes) this will start to return
+   negative numbers.
+
+.. function:: elapsed_millis(start)
+
+   Returns the number of milliseconds which have elapsed since ``start``.
+   
+   This function takes care of counter wrap, and always returns a positive
+   number. This means it can be used to measure periods upto about 12.4 days.
+   
+   Example::
+
+       start = pyb.millis()
+       while pyb.elapsed_millis(start) < 1000:
+           # Perform some operation
+
+.. function:: elapsed_micros(start)
+
+   Returns the number of microseconds which have elapsed since ``start``.
+   
+   This function takes care of counter wrap, and always returns a positive
+   number. This means it can be used to measure periods upto about 17.8 minutes.
+   
+   Example::
+
+       start = pyb.micros()
+       while pyb.elapsed_micros(start) < 1000:
+           # Perform some operation
+           pass
+
+Reset related functions
+-----------------------
+
+.. function:: hard_reset()
+
+   Resets the pyboard in a manner similar to pushing the external RESET
+   button.
+
+.. function:: bootloader()
+
+   Activate the bootloader without BOOT\* pins.
+
+Interrupt related functions
+---------------------------
+
+.. function:: disable_irq()
+
+   Disable interrupt requests.
+   Returns the previous IRQ state: ``False``/``True`` for disabled/enabled IRQs
+   respectively.  This return value can be passed to enable_irq to restore
+   the IRQ to its original state.
+
+.. function:: enable_irq(state=True)
+
+   Enable interrupt requests.
+   If ``state`` is ``True`` (the default value) then IRQs are enabled.
+   If ``state`` is ``False`` then IRQs are disabled.  The most common use of
+   this function is to pass it the value returned by ``disable_irq`` to
+   exit a critical section.
+
+Power related functions
+-----------------------
+
+.. function:: freq([sysclk[, hclk[, pclk1[, pclk2]]]])
+
+   If given no arguments, returns a tuple of clock frequencies:
+   (sysclk, hclk, pclk1, pclk2).
+   These correspond to:
+
+    - sysclk: frequency of the CPU
+    - hclk: frequency of the AHB bus, core memory and DMA
+    - pclk1: frequency of the APB1 bus
+    - pclk2: frequency of the APB2 bus
+
+   If given any arguments then the function sets the frequency of the CPU,
+   and the busses if additional arguments are given.  Frequencies are given in
+   Hz.  Eg freq(120000000) sets sysclk (the CPU frequency) to 120MHz.  Note that
+   not all values are supported and the largest supported frequency not greater
+   than the given value will be selected.
+
+   Supported sysclk frequencies are (in MHz): 8, 16, 24, 30, 32, 36, 40, 42, 48,
+   54, 56, 60, 64, 72, 84, 96, 108, 120, 144, 168.
+
+   The maximum frequency of hclk is 168MHz, of pclk1 is 42MHz, and of pclk2 is
+   84MHz.  Be sure not to set frequencies above these values.
+
+   The hclk, pclk1 and pclk2 frequencies are derived from the sysclk frequency
+   using a prescaler (divider).  Supported prescalers for hclk are: 1, 2, 4, 8,
+   16, 64, 128, 256, 512.  Supported prescalers for pclk1 and pclk2 are: 1, 2,
+   4, 8.  A prescaler will be chosen to best match the requested frequency.
+
+   A sysclk frequency of
+   8MHz uses the HSE (external crystal) directly and 16MHz uses the HSI
+   (internal oscillator) directly.  The higher frequencies use the HSE to
+   drive the PLL (phase locked loop), and then use the output of the PLL.
+
+   Note that if you change the frequency while the USB is enabled then
+   the USB may become unreliable.  It is best to change the frequency
+   in boot.py, before the USB peripheral is started.  Also note that sysclk
+   frequencies below 36MHz do not allow the USB to function correctly.
+
+.. function:: wfi()
+
+   Wait for an interrupt.
+   This executies a ``wfi`` instruction which reduces power consumption
+   of the MCU until an interrupt occurs, at which point execution continues.
+
+.. function:: standby()
+
+
+.. function:: stop()
+
+Miscellaneous functions
+-----------------------
+
+.. function:: have_cdc()
+
+   Return True if USB is connected as a serial device, False otherwise.
+
+.. function:: hid((buttons, x, y, z))
+
+   Takes a 4-tuple (or list) and sends it to the USB host (the PC) to
+   signal a HID mouse-motion event.
+
+.. function:: info([dump_alloc_table])
+
+   Print out lots of information about the board.
+
+.. function:: mount(device, mountpoint, \*, readonly=False, mkfs=False)
+
+   Mount a block device and make it available as part of the filesystem.
+   ``device`` must be an object that provides the block protocol:
+
+    - ``readblocks(self, blocknum, buf)``
+    - ``writeblocks(self, blocknum, buf)`` (optional)
+    - ``count(self)``
+    - ``sync(self)`` (optional)
+
+   ``readblocks`` and ``writeblocks`` should copy data between ``buf`` and
+   the block device, starting from block number ``blocknum`` on the device.
+   ``buf`` will be a bytearray with length a multiple of 512.  If
+   ``writeblocks`` is not defined then the device is mounted read-only.
+   The return value of these two functions is ignored.
+
+   ``count`` should return the number of blocks available on the device.
+   ``sync``, if implemented, should sync the data on the device.
+
+   The parameter ``mountpoint`` is the location in the root of the filesystem
+   to mount the device.  It must begin with a forward-slash.
+
+   If ``readonly`` is ``True``, then the device is mounted read-only,
+   otherwise it is mounted read-write.
+
+   If ``mkfs`` is ``True``, then a new filesystem is created if one does not
+   already exist.
+
+   To unmount a device, pass ``None`` as the device and the mount location
+   as ``mountpoint``.
+
+.. function:: repl_uart(uart)
+
+   Get or set the UART object that the REPL is repeated on.
+
+.. function:: rng()
+
+   Return a 30-bit hardware generated random number.
+
+.. function:: sync()
+
+   Sync all file systems.
+
+.. function:: unique_id()
+
+   Returns a string of 12 bytes (96 bits), which is the unique ID for the MCU.
+
+Classes
+-------
+
+.. toctree::
+   :maxdepth: 1
+
+   pyb.Accel.rst
+   pyb.ADC.rst
+   pyb.CAN.rst
+   pyb.DAC.rst
+   pyb.ExtInt.rst
+   pyb.I2C.rst
+   pyb.LCD.rst
+   pyb.LED.rst
+   pyb.Pin.rst
+   pyb.RTC.rst
+   pyb.Servo.rst
+   pyb.SPI.rst
+   pyb.Switch.rst
+   pyb.Timer.rst
+   pyb.UART.rst
+   pyb.USB_VCP.rst

docs/library/select.rst

@@ -0,0 +1,57 @@
+:mod:`select` -- wait for events on a set of streams
+========================================================================
+
+.. module:: select
+   :synopsis: wait for events on a set of streams
+
+This module provides functions to wait for events on streams (select streams
+which are ready for operations).
+
+Pyboard specifics
+-----------------
+
+Polling is an efficient way of waiting for read/write activity on multiple
+objects.  Current objects that support polling are: :class:`pyb.UART`,
+:class:`pyb.USB_VCP`.
+
+Functions
+---------
+
+.. function:: poll()
+
+   Create an instance of the Poll class.
+
+.. function:: select(rlist, wlist, xlist[, timeout])
+
+   Wait for activity on a set of objects.
+
+   This function is provided for compatibility and is not efficient. Usage
+   of :class:`Poll` is recommended instead.
+
+.. _class: Poll
+
+class ``Poll``
+--------------
+
+Methods
+~~~~~~~
+
+.. method:: poll.register(obj[, eventmask])
+
+   Register ``obj`` for polling.  ``eventmask`` is 1 for read, 2 for
+   write, 3 for read-write.
+
+.. method:: poll.unregister(obj)
+
+   Unregister ``obj`` from polling.
+
+.. method:: poll.modify(obj, eventmask)
+
+   Modify the ``eventmask`` for ``obj``.
+
+.. method:: poll.poll([timeout])
+
+   Wait for at least one of the registered objects to become ready. Returns
+   list of ready objects, or empty list on timeout.
+
+   Timeout is in milliseconds.

docs/library/struct.rst

@@ -0,0 +1,25 @@
+:mod:`struct` -- pack and unpack primitive data types
+=====================================================
+
+.. module:: struct
+   :synopsis: pack and unpack primitive data types
+
+See `Python struct <https://docs.python.org/3/library/struct.html>`_ for more
+information.
+
+Functions
+---------
+
+.. function:: calcsize(fmt)
+
+   Return the number of bytes needed to store the given ``fmt``.
+
+.. function:: pack(fmt, v1, v2, ...)
+
+   Pack the values ``v1``, ``v2``, ... according to the format string ``fmt``.
+   The return value is a bytes object encoding the values.
+
+.. function:: unpack(fmt, data)
+
+   Unpack from the ``data`` according to the format string ``fmt``.
+   The return value is a tuple of the unpacked values.

docs/library/sys.rst

@@ -0,0 +1,64 @@
+:mod:`sys` -- system specific functions
+=======================================
+
+.. module:: sys
+   :synopsis: system specific functions
+
+Functions
+---------
+
+.. function:: exit([retval])
+
+   Raise a ``SystemExit`` exception.  If an argument is given, it is the
+   value given to ``SystemExit``.
+
+.. function:: print_exception(exc, [file])
+
+   Print exception with a traceback to a file-like object ``file`` (or
+   ``sys.stdout`` by default).
+
+   .. admonition:: Difference to CPython
+      :class: attention
+
+      This function appears in the ``traceback`` module in CPython.
+
+Constants
+---------
+
+.. data:: argv
+
+   a mutable list of arguments this program started with
+
+.. data:: byteorder
+
+   the byte order of the system ("little" or "big")
+
+.. data:: path
+
+   a mutable list of directories to search for imported modules
+
+.. data:: platform
+
+   The platform that Micro Python is running on.  This is "pyboard" on the
+   pyboard and provides a robust way of determining if a script is running
+   on the pyboard or not.
+
+.. data:: stderr
+
+   standard error (connected to USB VCP, and optional UART object)
+
+.. data:: stdin
+
+   standard input (connected to USB VCP, and optional UART object)
+
+.. data:: stdout
+
+   standard output (connected to USB VCP, and optional UART object)
+
+.. data:: version
+
+   Python language version that this implementation conforms to, as a string
+
+.. data:: version_info
+
+   Python language version that this implementation conforms to, as a tuple of ints

docs/library/time.rst

@@ -0,0 +1,41 @@
+:mod:`time` -- time related functions
+=====================================
+
+.. module:: time
+   :synopsis: time related functions
+
+The ``time`` module provides functions for getting the current time and date,
+and for sleeping.
+
+Functions
+---------
+
+.. function:: localtime([secs])
+
+   Convert a time expressed in seconds since Jan 1, 2000 into an 8-tuple which
+   contains: (year, month, mday, hour, minute, second, weekday, yearday)
+   If secs is not provided or None, then the current time from the RTC is used.
+   year includes the century (for example 2014).
+
+   * month   is 1-12
+   * mday    is 1-31
+   * hour    is 0-23
+   * minute  is 0-59
+   * second  is 0-59
+   * weekday is 0-6 for Mon-Sun
+   * yearday is 1-366
+
+.. function:: mktime()
+
+   This is inverse function of localtime. It's argument is a full 8-tuple
+   which expresses a time as per localtime. It returns an integer which is
+   the number of seconds since Jan 1, 2000.
+
+.. function:: sleep(seconds)
+
+   Sleep for the given number of seconds.  Seconds can be a floating-point number to
+   sleep for a fractional number of seconds.
+
+.. function:: time()
+
+   Returns the number of seconds, as an integer, since 1/1/2000.

docs/library/ubinascii.rst

@@ -0,0 +1,15 @@
+:mod:`ubinascii` -- binary/ASCII conversions
+============================================
+
+.. module:: ubinascii
+   :synopsis: binary/ASCII conversions
+
+This module implements conversions between binary data and various
+encodings of it in ASCII form (in both directions).
+
+Functions
+---------
+
+.. function:: hexlify(data)
+
+   Convert binary data to hexadecimal representation. Return bytes string.

docs/library/uctypes.rst

@@ -0,0 +1,138 @@
+:mod:`uctypes` -- access C structures
+=====================================
+
+.. module:: uctypes
+   :synopsis: access C structures
+
+This module implements "foreign data interface" for MicroPython. The idea
+behind it is similar to CPython's ``ctypes`` modules, but actual API is
+different, steamlined and optimized for small size.
+
+Defining structure layout
+-------------------------
+
+Structure layout is defined by a "descriptor" - a Python dictionary which
+encodes field names as keys and other properties required to access them as
+an associated values. Currently, uctypes requires explicit specification of
+offsets for each field. Offset are given in bytes from structure start.
+
+Following are encoding examples for various field types:
+
+   Scalar types::
+
+    "field_name": uctypes.UINT32 | 0
+
+   in other words, value is scalar type identifier ORed with field offset
+   (in bytes) from the start of the structure.
+
+   Recursive structures::
+
+    "sub": (2, {
+        "b0": uctypes.UINT8 | 0,
+        "b1": uctypes.UINT8 | 1,
+    })
+
+   i.e. value is a 2-tuple, first element of which is offset, and second is
+   a structure descriptor dictionary (note: offsets in recursive descriptors
+   are relative to a structure it defines).
+
+   Arrays of primitive types::
+
+      "arr": (uctypes.ARRAY | 0, uctypes.UINT8 | 2),
+
+   i.e. value is a 2-tuple, first element of which is ARRAY flag ORed
+   with offset, and second is scalar element type ORed number of elements
+   in array.
+
+   Arrays of aggregate types::
+
+    "arr2": (uctypes.ARRAY | 0, 2, {"b": uctypes.UINT8 | 0}),
+
+   i.e. value is a 3-tuple, first element of which is ARRAY flag ORed
+   with offset, second is a number of elements in array, and third is
+   descriptor of element type.
+
+   Pointer to a primitive type::
+
+    "ptr": (uctypes.PTR | 0, uctypes.UINT8),
+
+   i.e. value is a 2-tuple, first element of which is PTR flag ORed
+   with offset, and second is scalar element type.
+
+   Pointer to aggregate type::
+
+    "ptr2": (uctypes.PTR | 0, {"b": uctypes.UINT8 | 0}),
+
+   i.e. value is a 2-tuple, first element of which is PTR flag ORed
+   with offset, second is descriptor of type pointed to.
+
+   Bitfields::
+
+    "bitf0": uctypes.BFUINT16 | 0 | 0 << uctypes.BF_POS | 8 << uctypes.BF_LEN,
+
+   i.e. value is type of scalar value containing given bitfield (typenames are
+   similar to scalar types, but prefixes with "BF"), ORed with offset for
+   scalar value containing the bitfield, and further ORed with values for
+   bit offset and bit length of the bitfield within scalar value, shifted by
+   BF_POS and BF_LEN positions, respectively. Bitfield position is counted
+   from the least significant bit, and is the number of right-most bit of a
+   field (in other words, it's a number of bits a scalar needs to be shifted
+   right to extra the bitfield).
+
+   In the example above, first UINT16 value will be extracted at offset 0
+   (this detail may be important when accessing hardware registers, where
+   particular access size and alignment are required), and then bitfield
+   whose rightmost bit is least-significant bit of this UINT16, and length
+   is 8 bits, will be extracted - effectively, this will access
+   least-significant byte of UINT16.
+
+   Note that bitfield operations are independent of target byte endianness,
+   in particular, example above will access least-significant byte of UINT16
+   in both little- and big-endian structures. But it depends on the least
+   significant bit being numbered 0. Some targets may use different
+   numbering in their native ABI, but ``uctypes`` always uses normalized
+   numbering described above.
+
+Module contents
+---------------
+
+.. class:: struct(descriptor, layout_type)
+
+   Create a "foreign data structure" object based on its descriptor (encoded
+   as a dictionary) and layout type.
+
+.. data:: LITTLE_ENDIAN
+
+   Little-endian packed structure. (Packed means that every field occupies
+   exactly many bytes as defined in the descriptor, i.e. alignment is 1).
+
+.. data:: BIG_ENDIAN
+
+   Big-endian packed structure.
+
+.. data:: NATIVE
+
+   Native structure - with data endianness and alignment conforming to
+   the target ABI.
+
+(to be continued)
+
+Structure objects
+-----------------
+
+Structure objects allow accessing individual fields using standard dot
+notation: ``my_struct.field1``. If a field is of scalar type, getting
+it will produce primitive value (Python integer or float) corresponding
+to value contained in a field. Scalar field can also be assigned to.
+
+If a field is an array, its individual elements can be accessed with
+standard subscript operator - both read and assigned to.
+
+If a field is a pointer, it can be dereferenced using ``[0]`` syntax
+(corresponding to C ``*`` operator, though ``[0]`` works in C too).
+Subscripting pointer with other integer values but 0 are supported too,
+with the same semantics as in C.
+
+Summing up, accessing structure fields generally follows C syntax,
+except for pointer derefence, you need to use ``[0]`` operator instead
+of ``*``.

docs/library/uhashlib.rst

@@ -0,0 +1,37 @@
+:mod:`uhashlib` -- hashing algorithm
+====================================
+
+.. module:: uhashlib
+   :synopsis: hashing algorithm
+
+This module implements binary data hashing algorithms. Currently, it
+implements SHA256 algorithm. Choosing SHA256 was a deliberate choice,
+as a modern, cryptographically secure algorithm. This means that a
+single algorithm can cover both usecases of "any hash algorithm" and
+security-related usage, and thus save space omitting legacy algorithms
+like MD5 or SHA1.
+
+Constructors
+------------
+
+.. class:: uhashlib.sha256([data])
+
+   Create a hasher object and optionally feed ``data`` into it.
+
+
+Methods
+-------
+
+.. method:: sha256.update(data)
+
+   Feed more binary data into hash.
+
+.. method:: sha256.digest()
+
+   Return hash for all data passed thru hash, as a bytes object. After this
+   method is called, more data cannot be fed into hash any longer.
+
+.. method:: sha256.hexdigest()
+
+   This method is NOT implemented. Use ``ubinascii.hexlify(sha256.digest())``
+   to achieve similar effect.

docs/library/uheapq.rst

@@ -0,0 +1,25 @@
+:mod:`uheapq` -- heap queue algorithm
+=====================================
+
+.. module:: uheapq
+   :synopsis: heap queue algorithm
+
+This module implements the heap queue algorithm.
+
+A heap queue is simply a list that has its elements stored in a certain way.
+
+Functions
+---------
+
+.. function:: heappush(heap, item)
+
+   Push the ``item`` onto the ``heap``.
+
+.. function:: heappop(heap)
+
+   Pop the first item from the ``heap``, and return it.  Raises IndexError if
+   heap is empty.
+
+.. function:: heapify(x)
+
+   Convert the list ``x`` into a heap.  This is an in-place operation.

docs/library/ujson.rst

@@ -0,0 +1,20 @@
+:mod:`ujson` -- JSON encoding and decoding
+==========================================
+
+.. module:: ujson
+   :synopsis: JSON encoding and decoding
+
+This modules allows to convert between Python objects and the JSON
+data format.
+
+Functions
+---------
+
+.. function:: dumps(obj)
+
+   Return ``obj`` represented as a JSON string.
+
+.. function:: loads(str)
+
+   Parse the JSON ``str`` and return an object.  Raises ValueError if the
+   string is not correctly formed.

docs/library/ure.rst

@@ -0,0 +1,82 @@
+:mod:`ure` -- regular expressions
+=================================
+
+.. module:: ure
+   :synopsis: regular expressions
+
+This module implements regular expression operations. Regular expression
+syntax supported is a subset of CPython ``re`` module (and actually is
+a subset of POSIX extended regular expressions).
+
+Supported operators are:
+
+``'.'``
+   Match any character.
+
+``'[]'``
+   Match set of characters. Individual characters and ranges are supported.
+
+``'^'``
+
+``'$'``
+
+``'?'``
+
+``'*'``
+
+``'+'``
+
+``'??'``
+
+``'*?'``
+
+``'+?'``
+
+Counted repetitions (``{m,n}``), more advanced assertions, names groups,
+etc. are not supported.
+
+
+Functions
+---------
+
+.. function:: compile(regex)
+
+   Compile regular expression, return ``regex`` object.
+
+.. function:: match(regex, string)
+
+   Match ``regex`` against ``string``. Match always happens from starting
+   position in a string.
+
+.. function:: search(regex, string)
+
+   Search ``regex`` in a ``string``. Unlike ``match``, this will search
+   string for first position which matches regex (which still may be
+   0 if regex is anchored).
+
+.. data:: DEBUG
+
+   Flag value, display debug information about compiled expression.
+
+
+Regex objects
+-------------
+
+Compiled regular expression. Instances of this class are created using
+``ure.compile()``.
+
+.. method:: regex.match(string)
+
+.. method:: regex.search(string)
+
+.. method:: regex.split(string, max_split=-1)
+
+
+Match objects
+-------------
+
+Match objects as returned by ``match()`` and ``search()`` methods.
+
+.. method:: match.group([index])
+
+   Only numeric groups are supported.

docs/library/usocket.rst

@@ -0,0 +1,17 @@
+:mod:`usocket` -- socket module
+===============================
+
+.. module:: usocket
+   :synopsis: socket module
+
+Socket functionality.
+
+Functions
+---------
+
+.. function:: getaddrinfo(host, port)
+
+
+.. function:: socket(family=AF_INET, type=SOCK_STREAM, fileno=-1)
+
+   Create a socket.

docs/library/uzlib.rst

@@ -0,0 +1,16 @@
+:mod:`uzlib` -- zlib decompression
+==================================
+
+.. module:: uzlib
+   :synopsis: zlib decompression
+
+This modules allows to decompress binary data compressed with DEFLATE
+algorithm (commonly used in zlib library and gzip archiver). Compression
+is not yet implemented.
+
+Functions
+---------
+
+.. function:: decompress(data)
+
+   Return decompressed data as bytes.

docs/license.rst

@@ -0,0 +1,24 @@
+Micro Python license information
+================================
+
+The MIT License (MIT)
+
+Copyright (c) 2013, 2014 Damien P. George, and others
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

docs/make.bat

@@ -0,0 +1,242 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
+set I18NSPHINXOPTS=%SPHINXOPTS% .
+if NOT "%PAPER%" == "" (
+	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+	:help
+	echo.Please use `make ^<target^>` where ^<target^> is one of
+	echo.  html       to make standalone HTML files
+	echo.  dirhtml    to make HTML files named index.html in directories
+	echo.  singlehtml to make a single large HTML file
+	echo.  pickle     to make pickle files
+	echo.  json       to make JSON files
+	echo.  htmlhelp   to make HTML files and a HTML help project
+	echo.  qthelp     to make HTML files and a qthelp project
+	echo.  devhelp    to make HTML files and a Devhelp project
+	echo.  epub       to make an epub
+	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+	echo.  text       to make text files
+	echo.  man        to make manual pages
+	echo.  texinfo    to make Texinfo files
+	echo.  gettext    to make PO message catalogs
+	echo.  changes    to make an overview over all changed/added/deprecated items
+	echo.  xml        to make Docutils-native XML files
+	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
+	echo.  linkcheck  to check all external links for integrity
+	echo.  doctest    to run all doctests embedded in the documentation if enabled
+	goto end
+)
+
+if "%1" == "clean" (
+	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+	del /q /s %BUILDDIR%\*
+	goto end
+)
+
+
+%SPHINXBUILD% 2> nul
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "html" (
+	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+	goto end
+)
+
+if "%1" == "dirhtml" (
+	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+	goto end
+)
+
+if "%1" == "singlehtml" (
+	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+	goto end
+)
+
+if "%1" == "pickle" (
+	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the pickle files.
+	goto end
+)
+
+if "%1" == "json" (
+	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can process the JSON files.
+	goto end
+)
+
+if "%1" == "htmlhelp" (
+	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+	goto end
+)
+
+if "%1" == "qthelp" (
+	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\MicroPython.qhcp
+	echo.To view the help file:
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MicroPython.ghc
+	goto end
+)
+
+if "%1" == "devhelp" (
+	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished.
+	goto end
+)
+
+if "%1" == "epub" (
+	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The epub file is in %BUILDDIR%/epub.
+	goto end
+)
+
+if "%1" == "latex" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdf" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "latexpdfja" (
+	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+	cd %BUILDDIR%/latex
+	make all-pdf-ja
+	cd %BUILDDIR%/..
+	echo.
+	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
+	goto end
+)
+
+if "%1" == "text" (
+	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The text files are in %BUILDDIR%/text.
+	goto end
+)
+
+if "%1" == "man" (
+	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The manual pages are in %BUILDDIR%/man.
+	goto end
+)
+
+if "%1" == "texinfo" (
+	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
+	goto end
+)
+
+if "%1" == "gettext" (
+	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
+	goto end
+)
+
+if "%1" == "changes" (
+	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.The overview file is in %BUILDDIR%/changes.
+	goto end
+)
+
+if "%1" == "linkcheck" (
+	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+	goto end
+)
+
+if "%1" == "doctest" (
+	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+	goto end
+)
+
+if "%1" == "xml" (
+	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The XML files are in %BUILDDIR%/xml.
+	goto end
+)
+
+if "%1" == "pseudoxml" (
+	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
+	if errorlevel 1 exit /b 1
+	echo.
+	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
+	goto end
+)
+
+:end

docs/quickref.rst

@@ -0,0 +1,152 @@
+.. _quickref:
+
+Quick reference for the pyboard
+===============================
+
+.. image:: http://micropython.org/resources/pybv10-pinout.jpg
+    :alt: PYBv1.0 pinout
+    :width: 700px
+
+General board control
+---------------------
+
+See :mod:`pyb`. ::
+
+    import pyb
+
+    pyb.delay(50) # wait 50 milliseconds
+    pyb.millis() # number of milliseconds since bootup
+    pyb.repl_uart(pyb.UART(1, 9600)) # duplicate REPL on UART(1)
+    pyb.wfi() # pause CPU, waiting for interrupt
+    pyb.freq() # get CPU and bus frequencies
+    pyb.freq(60000000) # set CPU freq to 60MHz
+    pyb.stop() # stop CPU, waiting for external interrupt
+
+LEDs
+----
+
+See :ref:`pyb.LED <pyb.LED>`. ::
+
+    from pyb import LED
+
+    led = LED(1) # red led
+    led.toggle()
+    led.on()
+    led.off()
+
+Pins and GPIO
+-------------
+
+See :ref:`pyb.Pin <pyb.Pin>`. ::
+
+    from pyb import Pin
+
+    p_out = Pin('X1', Pin.OUT_PP)
+    p_out.high()
+    p_out.low()
+
+    p_in = Pin('X2', Pin.IN, Pin.PULL_UP)
+    p_in.value() # get value, 0 or 1
+
+Servo control
+-------------
+
+See :ref:`pyb.Servo <pyb.Servo>`. ::
+
+    from pyb import Servo
+
+    s1 = Servo(1) # servo on position 1 (X1, VIN, GND)
+    s1.angle(45) # move to 45 degrees
+    s1.angle(-60, 1500) # move to -60 degrees in 1500ms
+    s1.speed(50) # for continuous rotation servos
+
+External interrupts
+-------------------
+
+See :ref:`pyb.ExtInt <pyb.ExtInt>`. ::
+
+    from pyb import Pin, ExtInt
+
+    callback = lambda e: print("intr")
+    ext = ExtInt(Pin('Y1'), ExtInt.IRQ_RISING, Pin.PULL_NONE, callback)
+
+Timers
+------
+
+See :ref:`pyb.Timer <pyb.Timer>`. ::
+
+    from pyb import Timer
+
+    tim = Timer(1, freq=1000)
+    tim.counter() # get counter value
+    tim.freq(0.5) # 0.5 Hz
+    tim.callback(lambda t: pyb.LED(1).toggle())
+
+PWM (pulse width modulation)
+----------------------------
+
+See :ref:`pyb.Pin <pyb.Pin>` and :ref:`pyb.Timer <pyb.Timer>`. ::
+
+    from pyb import Pin, Timer
+
+    p = Pin('X1') # X1 has TIM2, CH1
+    tim = Timer(2, freq=1000)
+    ch = tim.channel(1, Timer.PWM, pin=p)
+    ch.pulse_width_percent(50)
+
+ADC (analog to digital conversion)
+----------------------------------
+
+See :ref:`pyb.Pin <pyb.Pin>` and :ref:`pyb.ADC <pyb.ADC>`. ::
+
+    from pyb import Pin, ADC
+
+    adc = ADC(Pin('X19'))
+    adc.read() # read value, 0-4095
+
+DAC (digital to analog conversion)
+----------------------------------
+
+See :ref:`pyb.Pin <pyb.Pin>` and :ref:`pyb.DAC <pyb.DAC>`. ::
+
+    from pyb import Pin, DAC
+
+    dac = DAC(Pin('X5'))
+    dac.write(120) # output between 0 and 255
+
+UART (serial bus)
+-----------------
+
+See :ref:`pyb.UART <pyb.UART>`. ::
+
+    from pyb import UART
+
+    uart = UART(1, 9600)
+    uart.write('hello')
+    uart.read(5) # read up to 5 bytes
+
+SPI bus
+-------
+
+See :ref:`pyb.SPI <pyb.SPI>`. ::
+
+    from pyb import SPI
+
+    spi = SPI(1, SPI.MASTER, baudrate=200000, polarity=1, phase=0)
+    spi.send('hello')
+    spi.recv(5) # receive 5 bytes on the bus
+    spi.send_recv('hello') # send a receive 5 bytes
+
+I2C bus
+-------
+
+See :ref:`pyb.I2C <pyb.I2C>`. ::
+
+    from pyb import I2C
+
+    i2c = I2C(1, I2C.MASTER, baudrate=100000)
+    i2c.scan() # returns list of slave addresses
+    i2c.send('hello', 0x42) # send 5 bytes to slave with address 0x42
+    i2c.recv(5, 0x42) # receive 5 bytes from slave
+    i2c.mem_read(2, 0x42, 0x10) # read 2 bytes from slave 0x42, slave memory 0x10
+    i2c.mem_write('xy', 0x42, 0x10) # write 2 bytes to slave 0x42, slave memory 0x10

docs/readthedocs/settings/local_settings.py

@@ -0,0 +1,9 @@
+import os
+
+# Directory that the project lives in, aka ../..
+SITE_ROOT = '/'.join(os.path.dirname(__file__).split('/')[0:-2])
+
+TEMPLATE_DIRS = (
+    "%s/templates/" % SITE_ROOT, # Your custom template directory, before the RTD one to override it.
+    "%s/readthedocs/templates/" % SITE_ROOT, # Default RTD template dir
+)

docs/static/customstyle.css

@@ -0,0 +1,10 @@
+/* custom CSS for Micro Python docs
+ */
+
+.admonition-difference-to-cpython {
+    border: 1px solid black;
+}
+
+.admonition-difference-to-cpython .admonition-title {
+    margin: 4px;
+}

docs/templates/layout.html

@@ -0,0 +1,2 @@
+{% extends "!layout.html" %}
+{% set css_files = css_files + ["_static/customstyle.css"] %}

docs/topindex.html

@@ -0,0 +1,93 @@
+{% extends "defindex.html" %}
+{% block body %}
+
+  <h1>Micro Python documentation</h1>
+
+  <p>
+    {{ _('Welcome! This is the documentation for Micro Python') }}
+    v{{ release|e }}{% if last_updated %}, {{ _('last updated') }} {{ last_updated|e }}{% endif %}.
+  </p>
+
+  <p><strong>Documentation for Micro Python and the pyboard:</strong></p>
+
+  <table class="contentstable"><tr>
+    <td width="40%" style="padding-left:2em;">
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("quickref") }}">Quick reference for the pyboard</a><br/>
+        <span class="linkdescr">pinout for the pyboard and snippets of useful code</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("general") }}">General information about the pyboard</a><br/>
+        <span class="linkdescr">read this first for a quick overview</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("tutorial/index") }}">Tutorials and code examples</a><br/>
+        <span class="linkdescr">start here</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("library/index") }}">Library Reference</a><br/>
+        <span class="linkdescr">Micro Python libraries, including the <a href="{{ pathto("library/pyb") }}">pyb module</a></span>
+      </p>
+    </td>
+    <td width="40%" style="padding-left:2em;">
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("hardware/index") }}">The pyboard hardware</a><br/>
+        <span class="linkdescr">schematics, dimensions and component datasheets</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for pyboard on Windows (PDF)</a><br/>
+        <span class="linkdescr">including DFU programming</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("license") }}">License</a><br/>
+        <span class="linkdescr">Micro Python license information</span>
+      </p>
+    </td>
+  </tr></table>
+
+  <p><strong>Indices and tables:</strong></p>
+  <table class="contentstable"><tr>
+    <td width="40%" style="padding-left:2em;">
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("py-modindex") }}">Module index</a><br/>
+        <span class="linkdescr">quick access to all modules</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("genindex") }}">Full index</a><br/>
+        <span class="linkdescr">all functions, classes, constants</span>
+      </p>
+    </td>
+    <td width="40%" style="padding-left:2em;">
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("contents") }}">Table of contents</a><br/>
+        <span class="linkdescr">a list of all sections and subsections</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="{{ pathto("search") }}">Search page</a><br/>
+        <span class="linkdescr">search this documentation</span>
+      </p>
+    </td></tr>
+  </table>
+
+  <p><strong>External links:</strong></p>
+
+  <table class="contentstable"><tr>
+    <td width="40%" style="padding-left:2em;">
+      <p class="biglink">
+      <a class="biglink" href="http://micropython.org">Micro Python homepage</a><br/>
+        <span class="linkdescr">the official Micro Python site</span>
+      </p>
+      <p class="biglink">
+        <a class="biglink" href="http://forum.micropython.org">Micro Python forum</a><br/>
+        <span class="linkdescr">community discussion for all things related to Micro Python</span>
+      </p>
+    </td>
+    <td width="40%" style="padding-left:2em;">
+      <p class="biglink">
+        <a class="biglink" href="https://github.com/micropython">Micro Python on GitHub</a><br/>
+        <span class="linkdescr">contribute to the source code on GitHub</span>
+      </p>
+    </td>
+  </tr></table>
+
+{% endblock %}

docs/tutorial/accel.rst

@@ -0,0 +1,92 @@
+The accelerometer
+=================
+
+Here you will learn how to read the accelerometer and signal using LEDs states like tilt left and tilt right.
+
+Using the accelerometer
+-----------------------
+
+The pyboard has an accelerometer (a tiny mass on a tiny spring) that can be used
+to detect the angle of the board and motion. There is a different sensor for
+each of the x, y, z directions. To get the value of the accelerometer, create a
+pyb.Accel() object and then call the x() method. ::
+
+    >>> accel = pyb.Accel()
+    >>> accel.x()
+    7
+
+This returns a signed integer with a value between around -30 and 30. Note that
+the measurement is very noisy, this means that even if you keep the board
+perfectly still there will be some variation in the number that you measure.
+Because of this, you shouldn't use the exact value of the x() method but see if
+it is in a certain range.
+
+We will start by using the accelerometer to turn on a light if it is not flat. ::
+
+    accel = pyb.Accel()
+    light = pyb.LED(3)
+    SENSITIVITY = 3
+
+    while True:
+        x = accel.x()
+        if abs(x) > SENSITIVITY: 
+            light.on()
+        else:
+            light.off()
+
+        pyb.delay(100)
+
+We create Accel and LED objects, then get the value of the x direction of the
+accelerometer. If the magnitude of x is bigger than a certain value ``SENSITIVITY``,
+then the LED turns on, otherwise it turns off. The loop has a small ``pyb.delay()``
+otherwise the LED flashes annoyingly when the value of x is close to
+``SENSITIVITY``. Try running this on the pyboard and tilt the board left and right
+to make the LED turn on and off.
+
+**Exercise: Change the above script so that the blue LED gets brighter the more
+you tilt the pyboard.  HINT: You will need to rescale the values, intensity goes
+from 0-255.**
+
+Making a spirit level
+---------------------
+
+The example above is only sensitive to the angle in the x direction but if we
+use the ``y()`` value and more LEDs we can turn the pyboard into a spirit level. ::
+
+    xlights = (pyb.LED(2), pyb.LED(3))
+    ylights = (pyb.LED(1), pyb.LED(4))
+
+    accel = pyb.Accel()
+    SENSITIVITY = 3
+
+    while True:
+        x = accel.x()
+        if x > SENSITIVITY: 
+            xlights[0].on()
+            xlights[1].off()
+        elif x < -SENSITIVITY:
+            xlights[1].on()
+            xlights[0].off()
+        else:
+            xlights[0].off()
+            xlights[1].off()
+
+        y = accel.y()
+        if y > SENSITIVITY: 
+            ylights[0].on()
+            ylights[1].off()
+        elif y < -SENSITIVITY:
+            ylights[1].on()
+            ylights[0].off()
+        else:
+            ylights[0].off()
+            ylights[1].off()
+
+        pyb.delay(100)
+
+We start by creating a tuple of LED objects for the x and y directions. Tuples
+are immutable objects in python which means they can't be modified once they are
+created. We then proceed as before but turn on a different LED for positive and
+negative x values. We then do the same for the y direction. This isn't
+particularly sophisticated but it does the job. Run this on your pyboard and you
+should see different LEDs turning on depending on how you tilt the board.

docs/tutorial/amp_skin.rst

@@ -0,0 +1,72 @@
+The AMP audio skin
+==================
+
+Soldering and using the AMP audio skin.
+
+.. image:: img/skin_amp_1.jpg
+    :alt: AMP skin
+    :width: 250px
+
+.. image:: img/skin_amp_2.jpg
+    :alt: AMP skin
+    :width: 250px
+
+The following video shows how to solder the headers, microphone and speaker onto the AMP skin.
+
+.. raw:: html
+
+    <iframe style="margin-left:3em;" width="560" height="315" src="http://www.youtube.com/embed/fjB1DuZRveo?rel=0" frameborder="0" allowfullscreen></iframe>
+
+For circuit schematics and datasheets for the components on the skin see :ref:`hardware_index`.
+
+Example code
+------------
+
+The AMP skin has a speaker which is connected to ``DAC(1)`` via a small
+power amplifier.  The volume of the amplifier is controlled by a digital
+potentiometer, which is an I2C device with address 46 on the ``IC2(1)`` bus.
+
+To set the volume, define the following function::
+
+    import pyb
+    def volume(val):
+        pyb.I2C(1, pyb.I2C.MASTER).mem_write(val, 46, 0)
+
+Then you can do::
+
+    >>> volume(0)   # minimum volume
+    >>> volume(127) # maximum volume
+
+To play a sound, use the ``write_timed`` method of the ``DAC`` object.
+For example::
+
+    import math
+    from pyb import DAC
+
+    # create a buffer containing a sine-wave
+    buf = bytearray(100)
+    for i in range(len(buf)):
+        buf[i] = 128 + int(127 * math.sin(2 * math.pi * i / len(buf)))
+
+    # output the sine-wave at 400Hz
+    dac = DAC(1)
+    dac.write_timed(buf, 400 * len(buf), mode=DAC.CIRCULAR)
+
+You can also play WAV files using the Python ``wave`` module.  You can get
+the wave module `here <http://micropython.org/resources/examples/wave.py>`_ and you will also need
+the chunk module available `here <http://micropython.org/resources/examples/chunk.py>`_.  Put these
+on your pyboard (either on the flash or the SD card in the top-level directory).  You will need an
+8-bit WAV file to play, such as `this one <http://micropython.org/resources/examples/test.wav>`_,
+or to convert any file you have with the command::
+
+    avconv -i original.wav -ar 22050 -codec pcm_u8 test.wav
+    
+Then you can do::
+
+    >>> import wave
+    >>> from pyb import DAC
+    >>> dac = DAC(1)
+    >>> f = wave.open('test.wav')
+    >>> dac.write_timed(f.readframes(f.getnframes()), f.getframerate())
+
+This should play the WAV file.

docs/tutorial/assembler.rst

@@ -0,0 +1,123 @@
+Inline assembler
+================
+
+Here you will learn how to write inline assembler in Micro Python.
+
+**Note**: this is an advanced tutorial, intended for those who already
+know a bit about microcontrollers and assembly language.
+
+Micro Python includes an inline assembler.  It allows you to write
+assembly routines as a Python function, and you can call them as you would
+a normal Python function.
+
+Returning a value
+-----------------
+
+Inline assembler functions are denoted by a special function decorator.
+Let's start with the simplest example::
+
+    @micropython.asm_thumb
+    def fun():
+        movw(r0, 42)
+
+You can enter this in a script or at the REPL.  This function takes no
+arguments and returns the number 42.  ``r0`` is a register, and the value
+in this register when the function returns is the value that is returned.
+Micro Python always interprets the ``r0`` as an integer, and converts it to an
+integer object for the caller.
+
+If you run ``print(fun())`` you will see it print out 42.
+
+Accessing peripherals
+---------------------
+
+For something a bit more complicated, let's turn on an LED::
+
+    @micropython.asm_thumb
+    def led_on():
+        movwt(r0, stm.GPIOA)
+        movw(r1, 1 << 13)
+        strh(r1, [r0, stm.GPIO_BSRRL])
+
+This code uses a few new concepts:
+
+  - ``stm`` is a module which provides a set of constants for easy
+    access to the registers of the pyboard's microcontroller.  Try
+    running ``import stm`` and then ``help(stm)`` at the REPL.  It will
+    give you a list of all the available constants.
+
+  - ``stm.GPIOA`` is the address in memory of the GPIOA peripheral.
+    On the pyboard, the red LED is on port A, pin PA13.
+
+  - ``movwt`` moves a 32-bit number into a register.  It is a convenience
+    function that turns into 2 thumb instructions: ``movw`` followed by ``movt``.
+    The ``movt`` also shifts the immediate value right by 16 bits.
+
+  - ``strh`` stores a half-word (16 bits).  The instruction above stores
+    the lower 16-bits of ``r1`` into the memory location ``r0 + stm.GPIO_BSRRL``.
+    This has the effect of setting high all those pins on port A for which
+    the corresponding bit in ``r0`` is set.  In our example above, the 13th
+    bit in ``r0`` is set, so PA13 is pulled high.  This turns on the red LED.
+
+Accepting arguments
+-------------------
+
+Inline assembler functions can accept up to 3 arguments.  If they are
+used, they must be named ``r0``, ``r1`` and ``r2`` to reflect the registers
+and the calling conventions.
+
+Here is a function that adds its arguments::
+
+    @micropython.asm_thumb
+    def asm_add(r0, r1):
+        add(r0, r0, r1)
+
+This performs the computation ``r0 = r0 + r1``.  Since the result is put
+in ``r0``, that is what is returned.  Try ``asm_add(1, 2)``, it should return
+3.
+
+Loops
+-----
+
+We can assign labels with ``label(my_label)``, and branch to them using
+``b(my_label)``, or a conditional branch like ``bgt(my_label)``.
+
+The following example flashes the green LED.  It flashes it ``r0`` times. ::
+
+    @micropython.asm_thumb
+    def flash_led(r0):
+        # get the GPIOA address in r1
+        movwt(r1, stm.GPIOA)
+
+        # get the bit mask for PA14 (the pin LED #2 is on)
+        movw(r2, 1 << 14)
+
+        b(loop_entry)
+
+        label(loop1)
+
+        # turn LED on
+        strh(r2, [r1, stm.GPIO_BSRRL])
+
+        # delay for a bit
+        movwt(r4, 5599900)
+        label(delay_on)
+        sub(r4, r4, 1)
+        cmp(r4, 0)
+        bgt(delay_on)
+
+        # turn LED off
+        strh(r2, [r1, stm.GPIO_BSRRH])
+
+        # delay for a bit
+        movwt(r4, 5599900)
+        label(delay_off)
+        sub(r4, r4, 1)
+        cmp(r4, 0)
+        bgt(delay_off)
+
+        # loop r0 times
+        sub(r0, r0, 1)
+        label(loop_entry)
+        cmp(r0, 0)
+        bgt(loop1)

docs/tutorial/debounce.rst

@@ -0,0 +1,37 @@
+Debouncing a pin input
+======================
+
+A pin used as input from a switch or other mechanical device can have a lot
+of noise on it, rapidly changing from low to high when the switch is first
+pressed or released.  This noise can be eliminated using a capacitor (a
+debouncing circuit).  It can also be eliminated using a simple function that
+makes sure the value on the pin is stable.
+
+The following function does just this.  It gets the current value of the given
+pin, and then waits for the value to change.  The new pin value must be stable
+for a continuous 20ms for it to register the change.  You can adjust this time
+(to say 50ms) if you still have noise. ::
+
+    import pyb
+
+    def wait_pin_change(pin):
+        # wait for pin to change value
+        # it needs to be stable for a continuous 20ms
+        cur_value = pin.value()
+        active = 0
+        while active < 20:
+            if pin.value() != cur_value:
+                active += 1
+            else:
+                active = 0
+            pyb.delay(1)
+
+
+Use it something like this::
+
+    import pyb
+
+    pin_x1 = pyb.Pin('X1', pyb.Pin.IN, pyb.Pin.PULL_DOWN)
+    while True:
+        wait_pin_change(pin_x1)
+        pyb.LED(4).toggle()

docs/tutorial/fading_led.rst

@@ -0,0 +1,89 @@
+Fading LEDs
+===========
+
+In addition to turning LEDs on and off, it is also possible to control the brightness of an LED using `Pulse-Width Modulation (PWM) <http://en.wikipedia.org/wiki/Pulse-width_modulation>`_, a common technique for obtaining variable output from a digital pin. This allows us to fade an LED:
+
+.. image:: http://upload.wikimedia.org/wikipedia/commons/a/a9/Fade.gif
+
+Components
+----------
+
+You will need:
+
+- Standard 5 or 3 mm LED
+- 100 Ohm resistor
+- Wires
+- `Breadboard <http://en.wikipedia.org/wiki/Breadboard>`_ (optional, but makes things easier)
+
+Connecting Things Up
+--------------------
+
+For this tutorial, we will use the ``X1`` pin. Connect one end of the resistor to ``X1``, and the other end to the **anode** of the LED, which is the longer leg. Connect the **cathode** of the LED to ground.
+
+.. image:: img/fading_leds_breadboard_fritzing.png
+
+Code
+----
+By examining the :ref:`quickref`, we see that ``X1`` is connected to channel 1 of timer 5 (``TIM5 CH1``). Therefore we will first create a ``Timer`` object for timer 5, then create a ``TimerChannel`` object for channel 1::
+    
+    from pyb import Timer
+    from time import sleep
+    
+    # timer 5 will be created with a frequency of 100 Hz
+    tim = pyb.Timer(5, freq=100)
+    tchannel = tim.channel(1, Timer.PWM, pin=pyb.Pin.board.X1, pulse_width=0)
+
+Brightness of the LED in PWM is controlled by controlling the pulse-width, that is the amount of time the LED is on every cycle. With a timer frequency of 100 Hz, each cycle takes 0.01 second, or 10 ms.
+
+To achieve the fading effect shown at the beginning of this tutorial, we want to set the pulse-width to a small value, then slowly increase the pulse-width to brighten the LED, and start over when we reach some maximum brightness::
+
+    # maximum and minimum pulse-width, which corresponds to maximum
+    # and minimum brightness
+    max_width = 200000
+    min_width = 20000
+
+    # how much to change the pulse-width by each step
+    wstep = 1500
+    cur_width = min_width
+    
+    while True:
+      tchannel.pulse_width(cur_width)
+      
+      # this determines how often we change the pulse-width. It is
+      # analogous to frames-per-second
+      sleep(0.01)
+    
+      cur_width += wstep
+    
+      if cur_width > max_width:
+        cur_width = min_width
+
+Breathing Effect
+----------------
+
+If we want to have a breathing effect, where the LED fades from dim to bright then bright to dim, then we simply need to reverse the sign of ``wstep`` when we reach maximum brightness, and reverse it again at minimum brightness. To do this we modify the ``while`` loop to be::
+
+    while True:
+      tchannel.pulse_width(cur_width)
+    
+      sleep(0.01)
+    
+      cur_width += wstep
+    
+      if cur_width > max_width:
+        cur_width = max_width
+        wstep *= -1
+      elif cur_width < min_width:
+        cur_width = min_width
+        wstep *= -1
+
+Advanced Exercise
+-----------------
+
+You may have noticed that the LED brightness seems to fade slowly, but increases quickly. This is because our eyes interprets brightness logarithmically (`Weber's Law <http://www.telescope-optics.net/eye_intensity_response.htm>`_
+), while the LED's brightness changes linearly, that is by the same amount each time. How do you solve this problem? (Hint: what is the opposite of the logarithmic function?)
+
+Addendum
+--------
+
+We could have also used the digital-to-analog converter (DAC) to achieve the same effect. The PWM method has the advantage that it drives the LED with the same current each time, but for different lengths of time. This allows better control over the brightness, because LEDs do not necessarily exhibit a linear relationship between the driving current and brightness.

docs/tutorial/index.rst

@@ -0,0 +1,47 @@
+.. _tutorial-index:
+
+Micro Python tutorial
+=====================
+
+This tutorial is intended to get you started with your pyboard.
+All you need is a pyboard and a micro-USB cable to connect it to
+your PC.  If it is your first time, it is recommended to follow
+the tutorial through in the order below.
+
+.. toctree::
+   :maxdepth: 1
+   :numbered:
+
+   intro.rst
+   script.rst
+   repl.rst
+   leds.rst
+   switch.rst
+   accel.rst
+   reset.rst
+   usb_mouse.rst
+   timer.rst
+   assembler.rst
+   power_ctrl.rst
+
+Tutorials requiring extra components
+------------------------------------
+
+.. toctree::
+   :maxdepth: 1
+   :numbered:
+
+   servo.rst
+   fading_led.rst
+   lcd_skin.rst
+   amp_skin.rst
+
+Tips, tricks and useful things to know
+--------------------------------------
+
+.. toctree::
+   :maxdepth: 1
+   :numbered:
+
+   debounce.rst
+   pass_through.rst

docs/tutorial/intro.rst

@@ -0,0 +1,54 @@
+Introduction to the pyboard
+===========================
+
+To get the most out of your pyboard, there are a few basic things to
+understand about how it works.
+
+Caring for your pyboard
+-----------------------
+
+Because the pyboard does not have a housing it needs a bit of care:
+
+  - Be gentle when plugging/unplugging the USB cable.  Whilst the USB connector
+    is soldered through the board and is relatively strong, if it breaks off
+    it can be very difficult to fix.
+
+  - Static electricity can shock the components on the pyboard and destroy them.
+    If you experience a lot of static electricity in your area (eg dry and cold
+    climates), take extra care not to shock the pyboard.  If your pyboard came
+    in a black plastic box, then this box is the best way to store and carry the
+    pyboard as it is an anti-static box (it is made of a conductive plastic, with
+    conductive foam inside).
+
+As long as you take care of the hardware, you should be okay.  It's almost
+impossible to break the software on the pyboard, so feel free to play around
+with writing code as much as you like.  If the filesystem gets corrupt, see
+below on how to reset it.  In the worst case you might need to reflash the
+Micro Python software, but that can be done over USB.
+
+Layout of the pyboard
+---------------------
+
+The micro USB connector is on the top right, the micro SD card slot on
+the top left of the board.  There are 4 LEDs between the SD slot and
+USB connector.  The colours are: red on the bottom, then green, orange,
+and blue on the top.  There are 2 switches: the right one is the reset
+switch, the left is the user switch.
+
+Plugging in and powering on
+---------------------------
+
+The pyboard can be powered via USB.  Connect it to your PC via a micro USB
+cable.  There is only one way that the cable will fit.  Once connected,
+the green LED on the board should flash quickly.
+
+Powering by an external power source
+------------------------------------
+
+The pyboard can be powered by a battery or other external power source.
+
+**Be sure to connect the positive lead of the power supply to VIN, and
+ground to GND.  There is no polarity protection on the pyboard so you
+must be careful when connecting anything to VIN.**
+
+**The input voltage must be between 3.6V and 10V.**

docs/tutorial/lcd_skin.rst

@@ -0,0 +1,86 @@
+The LCD and touch-sensor skin
+=============================
+
+Soldering and using the LCD and touch-sensor skin.
+
+.. image:: img/skin_lcd_1.jpg
+    :alt: pyboard with LCD skin
+    :width: 250px
+
+.. image:: img/skin_lcd_2.jpg
+    :alt: pyboard with LCD skin
+    :width: 250px
+
+The following video shows how to solder the headers onto the LCD skin.
+At the end of the video, it shows you how to correctly connect the LCD skin to the pyboard.
+
+.. raw:: html
+
+    <iframe style="margin-left:3em;" width="560" height="315" src="http://www.youtube.com/embed/PowCzdLYbFM?rel=0" frameborder="0" allowfullscreen></iframe>
+
+For circuit schematics and datasheets for the components on the skin see :ref:`hardware_index`.
+
+Using the LCD
+-------------
+
+To get started using the LCD, try the following at the Micro Python prompt.
+Make sure the LCD skin is attached to the pyboard as pictured at the top of this page. ::
+
+    >>> import pyb
+    >>> lcd = pyb.LCD('X')
+    >>> lcd.light(True)
+    >>> lcd.write('Hello uPy!\n')
+
+You can make a simple animation using the code::
+
+    import pyb
+    lcd = pyb.LCD('X')
+    lcd.light(True)
+    for x in range(-80, 128):
+        lcd.fill(0)
+        lcd.text('Hello uPy!', x, 10, 1)
+        lcd.show()
+        pyb.delay(25)
+
+Using the touch sensor
+----------------------
+
+To read the touch-sensor data you need to use the I2C bus.  The
+MPR121 capacitive touch sensor has address 90.
+
+To get started, try::
+
+    >>> import pyb
+    >>> i2c = pyb.I2C(1, pyb.I2C.MASTER)
+    >>> i2c.mem_write(4, 90, 0x5e)
+    >>> touch = i2c.mem_read(1, 90, 0)[0]
+
+The first line above makes an I2C object, and the second line
+enables the 4 touch sensors.  The third line reads the touch
+status and the ``touch`` variable holds the state of the 4 touch
+buttons (A, B, X, Y).
+
+There is a simple driver `here <http://micropython.org/resources/examples/mpr121.py>`_
+which allows you to set the threshold and debounce parameters, and
+easily read the touch status and electrode voltage levels.  Copy
+this script to your pyboard (either flash or SD card, in the top
+directory or ``lib/`` directory) and then try::
+
+    >>> import pyb
+    >>> import mpr121
+    >>> m = mpr121.MPR121(pyb.I2C(1, pyb.I2C.MASTER))
+    >>> for i in range(100):
+    ...   print(m.touch_status())
+    ...   pyb.delay(100)
+    ...
+
+This will continuously print out the touch status of all electrodes.
+Try touching each one in turn.
+
+Note that if you put the LCD skin in the Y-position, then you need to
+initialise the I2C bus using::
+
+    >>> m = mpr121.MPR121(pyb.I2C(2, pyb.I2C.MASTER))
+
+There is also a demo which uses the LCD and the touch sensors together,
+and can be found `here <http://micropython.org/resources/examples/lcddemo.py>`_.

docs/tutorial/leds.rst

@@ -0,0 +1,75 @@
+Turning on LEDs and basic Python concepts
+=========================================
+
+The easiest thing to do on the pyboard is to turn on the LEDs attached to the board. Connect the board, and log in as described in tutorial 1. We will start by turning and LED on in the interpreter, type the following ::
+
+    >>> myled = pyb.LED(1)
+    >>> myled.on()
+    >>> myled.off()
+
+These commands turn the LED on and off.
+
+This is all very well but we would like this process to be automated. Open the file MAIN.PY on the pyboard in your favourite text editor. Write or paste the following lines into the file. If you are new to python, then make sure you get the indentation correct since this matters! ::
+
+    led = pyb.LED(2)
+    while True:
+        led.toggle()
+        pyb.delay(1000)
+
+When you save, the red light on the pyboard should turn on for about a second. To run the script, do a soft reset (CTRL-D). The pyboard will then restart and you should see a green light continuously flashing on and off. Success, the first step on your path to building an army of evil robots! When you are bored of the annoying flashing light then press CTRL-C at your terminal to stop it running.
+ 
+So what does this code do? First we need some terminology. Python is an object-oriented language, almost everything in python is a *class* and when you create an instance of a class you get an *object*. Classes have *methods* associated to them. A method (also called a member function) is used to interact with or control the object.
+
+The first line of code creates an LED object which we have then called led. When we create the object, it takes a single parameter which must be between 1 and 4, corresponding to the 4 LEDs on the board. The pyb.LED class has three important member functions that we will use: on(), off() and toggle(). The other function that we use is pyb.delay() this simply waits for a given time in miliseconds. Once we have created the LED object, the statement while True: creates an infinite loop which toggles the led between on and off and waits for 1 second.
+
+**Exercise: Try changing the time between toggling the led and turning on a different LED.**
+
+**Exercise: Connect to the pyboard directly, create a pyb.LED object and turn it on using the on() method.**
+
+A Disco on your pyboard
+-----------------------
+
+So far we have only used a single LED but the pyboard has 4 available. Let's start by creating an object for each LED so we can control each of them. We do that by creating a list of LEDS with a list comprehension. ::
+
+    leds = [pyb.LED(i) for i in range(1,5)]
+
+If you call pyb.LED() with a number that isn't 1,2,3,4 you will get an error message.
+Next we will set up an infinite loop that cycles through each of the LEDs turning them on and off. ::
+
+    n = 0
+    while True:
+      n = (n + 1) % 4
+      leds[n].toggle()
+      pyb.delay(50)
+
+Here, n keeps track of the current LED and every time the loop is executed we cycle to the next n (the % sign is a modulus operator that keeps n between 0 and 3.) Then we access the nth LED and toggle it. If you run this you should see each of the LEDs turning on then all turning off again in sequence.
+
+One problem you might find is that if you stop the script and then start it again that the LEDs are stuck on from the previous run, ruining our carefully choreographed disco. We can fix this by turning all the LEDs off when we initialise the script and then using a try/finally block. When you press CTRL-C, Micro Python generates a VCPInterrupt exception. Exceptions normally mean something has gone wrong and you can use a try: command to "catch" an exception. In this case it is just the user interrupting the script, so we don't need to catch the error but just tell Micro Python what to do when we exit. The finally block does this, and we use it to make sure all the LEDs are off. The full code is::
+
+    leds = [pyb.LED(i) for i in range(1,5)]
+    for l in leds: 
+        l.off()
+
+    n = 0
+    try:
+       while True:
+          n = (n + 1) % 4
+          leds[n].toggle()
+          pyb.delay(50)
+    finally:
+        for l in leds:
+            l.off()
+
+The Fourth Special LED
+----------------------
+
+The blue LED is special. As well as turning it on and off, you can control the intensity using the intensity() method. This takes a number between 0 and 255 that determines how bright it is. The following script makes the blue LED gradually brighter then turns it off again. ::
+
+    led = pyb.LED(4)
+    intensity = 0
+    while True:
+        intensity = (intensity + 1) % 255
+        led.intensity(intensity)
+        pyb.delay(20)
+
+You can call intensity() on the other LEDs but they can only be off or on. 0 sets them off and any other number up to 255 turns them on.

docs/tutorial/pass_through.rst

@@ -0,0 +1,18 @@
+Making a UART - USB pass through
+================================
+
+It's as simple as::
+
+    import pyb
+    import select
+
+    def pass_through(usb, uart):
+        usb.setinterrupt(-1)
+        while True:
+            select.select([usb, uart], [], [])
+            if usb.any():
+                uart.write(usb.read(256))
+            if uart.any():
+                usb.write(uart.read(256))
+
+    pass_through(pyb.USB_VCP(), pyb.UART(1, 9600))

docs/tutorial/power_ctrl.rst

@@ -0,0 +1,13 @@
+Power control
+=============
+
+:meth:`pyb.wfi` is used to reduce power consumption while waiting for an
+event such as an interrupt.  You would use it in the following situation::
+
+    while True:
+        do_some_processing()
+        pyb.wfi()
+
+Control the frequency using :meth:`pyb.freq`::
+
+    pyb.freq(30000000) # set CPU frequency to 30MHz

docs/tutorial/repl.rst

@@ -0,0 +1,110 @@
+Getting a Micro Python REPL prompt
+==================================
+
+REPL stands for Read Evaluate Print Loop, and is the name given to the
+interactive Micro Python prompt that you can access on the pyboard.  Using
+the REPL is by far the easiest way to test out your code and run commands.
+You can use the REPL in addition to writing scripts in ``main.py``.
+
+To use the REPL, you must connect to the serial USB device on the pyboard.
+How you do this depends on your operating system.
+
+Windows
+-------
+
+You need to install the pyboard driver to use the serial USB device.
+The driver is on the pyboard's USB flash drive, and is called ``pybcdc.inf``.
+
+To install this driver you need to go to Device Manager
+for your computer, find the pyboard in the list of devices (it should have
+a warning sign next to it because it's not working yet), right click on
+the pyboard device, select Properties, then Install Driver.  You need to
+then select the option to find the driver manually (don't use Windows auto update),
+navigate to the pyboard's USB drive, and select that.  It should then install.
+After installing, go back to the Device Manager to find the installed pyboard,
+and see which COM port it is (eg COM4).
+More comprehensive instructions can be found in the
+`Guide for pyboard on Windows (PDF) <http://micropython.org/resources/Micro-Python-Windows-setup.pdf>`_.
+Please consult this guide if you are having problems installing the driver.
+
+You now need to run your terminal program.  You can use HyperTerminal if you
+have it installed, or download the free program PuTTY:
+`putty.exe <http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html>`_.
+Using your serial program you must connect to the COM port that you found in the
+previous step.  With PuTTY, click on "Session" in the left-hand panel, then click
+the "Serial" radio button on the right, then enter you COM port (eg COM4) in the
+"Serial Line" box.  Finally, click the "Open" button.
+
+Mac OS X
+--------
+
+Open a terminal and run::
+
+    screen /dev/tty.usbmodem*
+    
+When you are finished and want to exit screen, type CTRL-A CTRL-\\.
+
+Linux
+-----
+
+Open a terminal and run::
+
+    screen /dev/ttyACM0
+    
+You can also try ``picocom`` or ``minicom`` instead of screen.  You may have to
+use ``/dev/ttyACM1`` or a higher number for ``ttyACM``.  And, you may need to give
+yourself the correct permissions to access this devices (eg group ``uucp`` or ``dialout``,
+or use sudo).
+
+Using the REPL prompt
+---------------------
+
+Now let's try running some Micro Python code directly on the pyboard.
+
+With your serial program open (PuTTY, screen, picocom, etc) you may see a blank
+screen with a flashing cursor.  Press Enter and you should be presented with a
+Micro Python prompt, i.e. ``>>>``.  Let's make sure it is working with the obligatory test::
+
+    >>> print("hello pyboard!")
+    hello pyboard!
+
+In the above, you should not type in the ``>>>`` characters.  They are there to
+indicate that you should type the text after it at the prompt.  In the end, once
+you have entered the text ``print("hello pyboard!")`` and pressed Enter, the output
+on your screen should look like it does above.
+
+If you already know some python you can now try some basic commands here. 
+
+If any of this is not working you can try either a hard reset or a soft reset;
+see below.
+
+Go ahead and try typing in some other commands.  For example::
+
+    >>> pyb.LED(1).on()
+    >>> pyb.LED(2).on()
+    >>> 1 + 2
+    3
+    >>> 1 / 2
+    0.5
+    >>> 20 * 'py'
+    'pypypypypypypypypypypypypypypypypypypypy'
+
+Resetting the board
+-------------------
+
+If something goes wrong, you can reset the board in two ways. The first is to press CTRL-D
+at the Micro Python prompt, which performs a soft reset.  You will see a message something like ::
+
+    >>> 
+    PYB: sync filesystems
+    PYB: soft reboot
+    Micro Python v1.0 on 2014-05-03; PYBv1.0 with STM32F405RG
+    Type "help()" for more information.
+    >>>
+
+If that isn't working you can perform a hard reset (turn-it-off-and-on-again) by pressing the RST
+switch (the small black button closest to the micro-USB socket on the board). This will end your
+session, disconnecting whatever program (PuTTY, screen, etc) that you used to connect to the pyboard.
+
+If you are going to do a hard-reset, it's recommended to first close your serial program and eject/unmount
+the pyboard drive.

docs/tutorial/reset.rst

@@ -0,0 +1,60 @@
+Safe mode and factory reset
+===========================
+
+If something goes wrong with your pyboard, don't panic!  It is almost
+impossible for you to break the pyboard by programming the wrong thing.
+
+The first thing to try is to enter safe mode: this temporarily skips
+execution of ``boot.py`` and ``main.py`` and gives default USB settings.
+
+If you have problems with the filesystem you can do a factory reset,
+which restores the filesystem to its original state.
+
+Safe mode
+---------
+
+To enter safe mode, do the following steps:
+
+1. Connect the pyboard to USB so it powers up.
+2. Hold down the USR switch.
+3. While still holding down USR, press and release the RST switch.
+4. The LEDs will then cycle green to orange to green+orange and back again.
+5. Keep holding down USR until *only the orange LED is lit*, and then let
+   go of the USR switch.
+6. The orange LED should flash quickly 4 times, and then turn off.  
+7. You are now in safe mode.
+
+In safe mode, the ``boot.py`` and ``main.py`` files are not executed, and so
+the pyboard boots up with default settings.  This means you now have access
+to the filesystem (the USB drive should appear), and you can edit ``boot.py``
+and ``main.py`` to fix any problems.
+
+Entering safe mode is temporary, and does not make any changes to the
+files on the pyboard.
+
+Factory reset the filesystem
+----------------------------
+
+If you pyboard's filesystem gets corrupted (for example, you forgot to
+eject/unmount it), or you have some code in ``boot.py`` or ``main.py`` which
+you can't escape from, then you can reset the filesystem.
+
+Resetting the filesystem deletes all files on the internal pyboard storage
+(not the SD card), and restores the files ``boot.py``, ``main.py``, ``README.txt``
+and ``pybcdc.inf`` back to their original state.
+
+To do a factory reset of the filesystem you follow a similar procedure as
+you did to enter safe mode, but release USR on green+orange:
+
+1. Connect the pyboard to USB so it powers up.
+2. Hold down the USR switch.
+3. While still holding down USR, press and release the RST switch.
+4. The LEDs will then cycle green to orange to green+orange and back again.
+5. Keep holding down USR until *both the green and orange LEDs are lit*, and
+   then let go of the USR switch.
+6. The green and orange LEDs should flash quickly 4 times.
+7. The red LED will turn on (so red, green and orange are now on).
+8. The pyboard is now resetting the filesystem (this takes a few seconds).
+9. The LEDs all turn off.
+10. You now have a reset filesystem, and are in safe mode.
+11. Press and release the RST switch to boot normally.

docs/tutorial/script.rst

@@ -0,0 +1,105 @@
+Running your first script
+=========================
+
+Let's jump right in and get a Python script running on the pyboard.  After
+all, that's what it's all about!
+
+Connecting your pyboard
+-----------------------
+
+Connect your pyboard to your PC (Windows, Mac or Linux) with a micro USB cable.
+There is only one way that the cable will connect, so you can't get it wrong.
+
+.. image:: img/pyboard_usb_micro.jpg
+
+When the pyboard is connected to your PC it will power on and enter the start up
+process (the boot process).  The green LED should light up for half a second or
+less, and when it turns off it means the boot process has completed.
+
+Opening the pyboard USB drive
+-----------------------------
+
+Your PC should now recognise the pyboard.  It depends on the type of PC you
+have as to what happens next:
+
+  - **Windows**: Your pyboard will appear as a removable USB flash drive.
+    Windows may automatically pop-up a window, or you may need to go there
+    using Explorer.
+
+    Windows will also see that the pyboard has a serial device, and it will
+    try to automatically configure this device.  If it does, cancel the process.
+    We will get the serial device working in the next tutorial.
+
+  - **Mac**: Your pyboard will appear on the desktop as a removable disc.
+    It will probably be called "NONAME".  Click on it to open the pyboard folder.
+
+  - **Linux**: Your pyboard will appear as a removable medium.  On Ubuntu
+    it will mount automatically and pop-up a window with the pyboard folder.
+    On other Linux distributions, the pyboard may be mounted automatically,
+    or you may need to do it manually.  At a terminal command line, type ``lsblk``
+    to see a list of connected drives, and then ``mount /dev/sdb1`` (replace ``sdb1``
+    with the appropriate device).  You may need to be root to do this.
+
+Okay, so you should now have the pyboard connected as a USB flash drive, and
+a window (or command line) should be showing the files on the pyboard drive.
+
+The drive you are looking at is known as ``/flash`` by the pyboard, and should contain
+the following 4 files:
+
+* `boot.py <http://micropython.org/resources/fresh-pyboard/boot.py>`_ -- this script is executed when the pyboard boots up.  It sets
+    up various configuration options for the pyboard.
+
+* `main.py <http://micropython.org/resources/fresh-pyboard/main.py>`_ -- this is the main script that will contain your Python program.
+    It is executed after ``boot.py``.
+
+* `README.txt <http://micropython.org/resources/fresh-pyboard/README.txt>`_ -- this contains some very basic information about getting
+    started with the pyboard.
+
+* `pybcdc.inf <http://micropython.org/resources/fresh-pyboard/pybcdc.inf>`_ -- this is a Windows driver file to configure the serial USB
+    device.  More about this in the next tutorial.
+
+Editing ``main.py``
+-------------------
+
+Now we are going to write our Python program, so open the ``main.py``
+file in a text editor.  On Windows you can use notepad, or any other editor.
+On Mac and Linux, use your favourite text editor.  With the file open you will
+see it contains 1 line::
+
+    # main.py -- put your code here!
+
+This line starts with a # character, which means that it is a *comment*.  Such
+lines will not do anything, and are there for you to write notes about your
+program.
+
+Let's add 2 lines to this ``main.py`` file, to make it look like this::
+
+    # main.py -- put your code here!
+    import pyb
+    pyb.LED(4).on()
+
+The first line we wrote says that we want to use the ``pyb`` module.
+This module contains all the functions and classes to control the features
+of the pyboard.
+
+The second line that we wrote turns the blue LED on: it first gets the ``LED``
+class from the ``pyb`` module, creates LED number 4 (the blue LED), and then
+turns it on.
+
+Resetting the pyboard
+---------------------
+
+To run this little script, you need to first save and close the ``main.py`` file,
+and then eject (or unmount) the pyboard USB drive.  Do this like you would a
+normal USB flash drive.
+
+When the drive is safely ejected/unmounted you can get to the fun part:
+press the RST switch on the pyboard to reset and run your script. The RST
+switch is the small black button just below the USB connector on the board,
+on the right edge.
+
+When you press RST the green LED will flash quickly, and then the blue
+LED should turn on and stay on.
+
+Congratulations!  You have written and run your very first Micro Python
+program!

docs/tutorial/servo.rst

@@ -0,0 +1,146 @@
+Controlling hobby servo motors
+==============================
+
+There are 4 dedicated connection points on the pyboard for connecting up
+hobby servo motors (see eg
+[Wikipedia](http://en.wikipedia.org/wiki/Servo_%28radio_control%29)).
+These motors have 3 wires: ground, power and signal.  On the pyboard you
+can connect them in the bottom right corner, with the signal pin on the
+far right.  Pins X1, X2, X3 and X4 are the 4 dedicated servo signal pins.
+
+.. image:: img/pyboard_servo.jpg
+
+In this picture there are male-male double adaptors to connect the servos
+to the header pins on the pyboard.
+
+The ground wire on a servo is usually the darkest coloured one, either
+black or dark brown.  The power wire will most likely be red.
+
+The power pin for the servos (labelled VIN) is connected directly to the
+input power source of the pyboard.  When powered via USB, VIN is powered
+through a diode by the 5V USB power line.  Connect to USB, the pyboard can
+power at least 4 small to medium sized servo motors.
+
+If using a battery to power the pyboard and run servo motors, make sure it
+is not greater than 6V, since this is the maximum voltage most servo motors
+can take.  (Some motors take only up to 4.8V, so check what type you are
+using.)
+
+Creating a Servo object
+-----------------------
+
+Plug in a servo to position 1 (the one with pin X1) and create a servo object
+using::
+
+    >>> servo1 = pyb.Servo(1)
+
+To change the angle of the servo use the ``angle`` method::
+
+    >>> servo1.angle(45)
+    >>> servo1.angle(-60)
+
+The angle here is measured in degrees, and ranges from about -90 to +90,
+depending on the motor.  Calling ``angle`` without parameters will return
+the current angle::
+
+    >>> servo1.angle()
+    -60
+
+Note that for some angles, the returned angle is not exactly the same as
+the angle you set, due to rounding errors in setting the pulse width.
+
+You can pass a second parameter to the ``angle`` method, which specifies how
+long to take (in milliseconds) to reach the desired angle.  For example, to
+take 1 second (1000 milliseconds) to go from the current position to 50 degrees,
+use ::
+
+     >>> servo1.angle(50, 1000)
+
+This command will return straight away and the servo will continue to move
+to the desired angle, and stop when it gets there.  You can use this feature
+as a speed control, or to synchronise 2 or more servo motors.  If we have
+another servo motor (``servo2 = pyb.Servo(2)``) then we can do ::
+
+    >>> servo1.angle(-45, 2000); servo2.angle(60, 2000)
+
+This will move the servos together, making them both take 2 seconds to
+reach their final angles.
+
+Note: the semicolon between the 2 expressions above is used so that they
+are executed one after the other when you press enter at the REPL prompt.
+In a script you don't need to do this, you can just write them one line
+after the other.
+
+Continuous rotation servos
+--------------------------
+
+So far we have been using standard servos that move to a specific angle
+and stay at that angle.  These servo motors are useful to create joints
+of a robot, or things like pan-tilt mechanisms.  Internally, the motor
+has a variable resistor (potentiometer) which measures the current angle
+and applies power to the motor proportional to how far it is from the
+desired angle.  The desired angle is set by the width of a high-pulse on
+the servo signal wire.  A pulse width of 1500 microsecond corresponds
+to the centre position (0 degrees).  The pulses are sent at 50 Hz, ie
+50 pulses per second.
+
+You can also get **continuous rotation** servo motors which turn
+continuously clockwise or counterclockwise.  The direction and speed of
+rotation is set by the pulse width on the signal wire.  A pulse width
+of 1500 microseconds corresponds to a stopped motor.  A pulse width
+smaller or larger than this means rotate one way or the other, at a
+given speed.
+
+On the pyboard, the servo object for a continuous rotation motor is
+the same as before.  In fact, using ``angle`` you can set the speed.  But
+to make it easier to understand what is intended, there is another method
+called ``speed`` which sets the speed::
+
+    >>> servo1.speed(30)
+
+``speed`` has the same functionality as ``angle``: you can get the speed,
+set it, and set it with a time to reach the final speed. ::
+
+    >>> servo1.speed()
+    30
+    >>> servo1.speed(-20)
+    >>> servo1.speed(0, 2000)
+
+The final command above will set the motor to stop, but take 2 seconds
+to do it.  This is essentially a control over the acceleration of the
+continuous servo.
+
+A servo speed of 100 (or -100) is considered maximum speed, but actually
+you can go a bit faster than that, depending on the particular motor.
+
+The only difference between the ``angle`` and ``speed`` methods (apart from
+the name) is the way the input numbers (angle or speed) are converted to
+a pulse width.
+
+Calibration
+-----------
+
+The conversion from angle or speed to pulse width is done by the servo
+object using its calibration values.  To get the current calibration,
+use ::
+
+    >>> servo1.calibration()
+    (640, 2420, 1500, 2470, 2200)
+
+There are 5 numbers here, which have meaning:
+
+1. Minimum pulse width; the smallest pulse width that the servo accepts.
+2. Maximum pulse width; the largest pulse width that the servo accepts.
+3. Centre pulse width; the pulse width that puts the servo at 0 degrees
+   or 0 speed.
+4. The pulse width corresponding to 90 degrees.  This sets the conversion
+   in the method ``angle`` of angle to pulse width.
+5. The pulse width corresponding to a speed of 100.  This sets the conversion
+   in the method ``speed`` of speed to pulse width.
+
+You can recalibrate the servo (change its default values) by using::
+
+    >>> servo1.calibration(700, 2400, 1510, 2500, 2000)
+
+Of course, you would change the above values to suit your particular
+servo motor.

docs/tutorial/switch.rst

@@ -0,0 +1,101 @@
+The Switch, callbacks and interrupts
+====================================
+
+The pyboard has 2 small switches, labelled USR and RST.  The RST switch
+is a hard-reset switch, and if you press it then it restarts the pyboard
+from scratch, equivalent to turning the power off then back on.
+
+The USR switch is for general use, and is controlled via a Switch object.
+To make a switch object do::
+
+    >>> sw = pyb.Switch()
+
+Remember that you may need to type ``import pyb`` if you get an error that
+the name ``pyb`` does not exist.
+
+With the switch object you can get its status::
+
+    >>> sw()
+    False
+
+This will print ``False`` if the switch is not held, or ``True`` if it is held.
+Try holding the USR switch down while running the above command.
+
+Switch callbacks
+----------------
+
+The switch is a very simple object, but it does have one advanced feature:
+the ``sw.callback()`` function.  The callback function sets up something to
+run when the switch is pressed, and uses an interrupt.  It's probably best
+to start with an example before understanding how interrupts work.  Try
+running the following at the prompt::
+
+    >>> sw.callback(lambda:print('press!'))
+
+This tells the switch to print ``press!`` each time the switch is pressed
+down.  Go ahead and try it: press the USR switch and watch the output on
+your PC.  Note that this print will interrupt anything you are typing, and
+is an example of an interrupt routine running asynchronously.
+
+As another example try::
+
+    >>> sw.callback(lambda:pyb.LED(1).toggle())
+
+This will toggle the red LED each time the switch is pressed.  And it will
+even work while other code is running.
+
+To disable the switch callback, pass ``None`` to the callback function::
+
+    >>> sw.callback(None)
+
+You can pass any function (that takes zero arguments) to the switch callback.
+Above we used the ``lambda`` feature of Python to create an anonymous function
+on the fly.  But we could equally do::
+
+    >>> def f():
+    ...   pyb.LED(1).toggle()
+    ...
+    >>> sw.callback(f)
+
+This creates a function called ``f`` and assigns it to the switch callback.
+You can do things this way when your function is more complicated than a
+``lambda`` will allow.
+
+Note that your callback functions must not allocate any memory (for example
+they cannot create a tuple or list).  Callback functions should be relatively
+simple.  If you need to make a list, make it beforehand and store it in a
+global variable (or make it local and close over it).  If you need to do
+a long, complicated calculation, then use the callback to set a flag which
+some other code then responds to.
+
+Technical details of interrupts
+-------------------------------
+
+Let's step through the details of what is happening with the switch
+callback.  When you register a function with ``sw.callback()``, the switch
+sets up an external interrupt trigger (falling edge) on the pin that the
+switch is connected to.  This means that the microcontroller will listen
+on the pin for any changes, and the following will occur:
+
+1. When the switch is pressed a change occurs on the pin (the pin goes
+   from low to high), and the microcontroller registers this change.
+2. The microcontroller finishes executing the current machine instruction,
+   stops execution, and saves its current state (pushes the registers on
+   the stack).  This has the effect of pausing any code, for example your
+   running Python script.
+3. The microcontroller starts executing the special interrupt handler
+   associated with the switch's external trigger.  This interrupt handler
+   get the function that you registered with ``sw.callback()`` and executes
+   it.
+4. Your callback function is executed until it finishes, returning control
+   to the switch interrupt handler.
+5. The switch interrupt handler returns, and the microcontroller is
+   notified that the interrupt has been dealt with.
+6. The microcontroller restores the state that it saved in step 2.
+7. Execution continues of the code that was running at the beginning.  Apart
+   from the pause, this code does not notice that it was interrupted.
+
+The above sequence of events gets a bit more complicated when multiple
+interrupts occur at the same time.  In that case, the interrupt with the
+highest priority goes first, then the others in order of their priority.
+The switch interrupt is set at the lowest priority.

docs/tutorial/timer.rst

@@ -0,0 +1,112 @@
+The Timers
+==========
+
+The pyboard has 14 timers which each consist of an independent counter
+running at a user-defined frequency.  They can be set up to run a function
+at specific intervals.
+The 14 timers are numbered 1 through 14, but 3 is reserved
+for internal use, and 5 and 6 are used for servo and ADC/DAC control.
+Avoid using these timers if possible.
+
+Let's create a timer object::
+
+    >>> tim = pyb.Timer(4)
+
+Now let's see what we just created::
+
+    >>> tim
+    Timer(4)
+
+The pyboard is telling us that ``tim`` is attached to timer number 4, but
+it's not yet initialised.  So let's initialise it to trigger at 10 Hz
+(that's 10 times per second)::
+
+    >>> tim.init(freq=10)
+
+Now that it's initialised, we can see some information about the timer::
+
+    >>> tim
+    Timer(4, prescaler=255, period=32811, mode=0, div=0)
+
+The information means that this timer is set to run at the peripheral
+clock speed divided by 255, and it will count up to 32811, at which point
+it triggers an interrupt, and then starts counting again from 0.  These
+numbers are set to make the timer trigger at 10 Hz.
+
+Timer counter
+-------------
+
+So what can we do with our timer?  The most basic thing is to get the
+current value of its counter::
+
+    >>> tim.counter()
+    21504
+
+This counter will continuously change, and counts up.
+
+Timer callbacks
+---------------
+
+The next thing we can do is register a callback function for the timer to
+execute when it triggers (see the [switch tutorial](tut-switch) for an
+introduction to callback functions)::
+
+    >>> tim.callback(lambda t:pyb.LED(1).toggle())
+
+This should start the red LED flashing right away.  It will be flashing
+at 5 Hz (2 toggle's are needed for 1 flash, so toggling at 10 Hz makes
+it flash at 5 Hz).  You can change the frequency by re-initialising the
+timer::
+
+    >>> tim.init(freq=20)
+
+You can disable the callback by passing it the value ``None``::
+
+    >>> tim.callback(None)
+
+The function that you pass to callback must take 1 argument, which is
+the timer object that triggered.  This allows you to control the timer
+from within the callback function.
+
+We can create 2 timers and run them independently::
+
+    >>> tim4 = pyb.Timer(4, freq=10)
+    >>> tim7 = pyb.Timer(7, freq=20)
+    >>> tim4.callback(lambda t: pyb.LED(1).toggle())
+    >>> tim7.callback(lambda t: pyb.LED(2).toggle())
+
+Because the callbacks are proper hardware interrupts, we can continue
+to use the pyboard for other things while these timers are running.
+
+Making a microsecond counter
+----------------------------
+
+You can use a timer to create a microsecond counter, which might be
+useful when you are doing something which requires accurate timing.
+We will use timer 2 for this, since timer 2 has a 32-bit counter (so
+does timer 5, but if you use timer 5 then you can't use the Servo
+driver at the same time).
+
+We set up timer 2 as follows::
+
+    >>> micros = pyb.Timer(2, prescaler=83, period=0x3fffffff)
+
+The prescaler is set at 83, which makes this timer count at 1 MHz.
+This is because the CPU clock, running at 168 MHz, is divided by
+2 and then by prescaler+1, giving a freqency of 168 MHz/2/(83+1)=1 MHz
+for timer 2.  The period is set to a large number so that the timer
+can count up to a large number before wrapping back around to zero.
+In this case it will take about 17 minutes before it cycles back to
+zero.
+
+To use this timer, it's best to first reset it to 0::
+
+    >>> micros.counter(0)
+
+and then perform your timing::
+
+    >>> start_micros = micros.counter()
+
+    ... do some stuff ...
+
+    >>> end_micros = micros.counter()

docs/tutorial/usb_mouse.rst

@@ -0,0 +1,129 @@
+Making the pyboard act as a USB mouse
+=====================================
+
+The pyboard is a USB device, and can configured to act as a mouse instead
+of the default USB flash drive.
+
+To do this we must first edit the ``boot.py`` file to change the USB
+configuration.  If you have not yet touched your ``boot.py`` file then it
+will look something like this::
+
+    # boot.py -- run on boot-up
+    # can run arbitrary Python, but best to keep it minimal
+
+    import pyb
+    #pyb.main('main.py') # main script to run after this one
+    #pyb.usb_mode('CDC+MSC') # act as a serial and a storage device
+    #pyb.usb_mode('CDC+HID') # act as a serial device and a mouse
+
+To enable the mouse mode, uncomment the last line of the file, to
+make it look like::
+
+    pyb.usb_mode('CDC+HID') # act as a serial device and a mouse
+
+If you already changed your ``boot.py`` file, then the minimum code it
+needs to work is::
+
+    import pyb
+    pyb.usb_mode('CDC+HID')
+
+This tells the pyboard to configure itself as a CDC (serial) and HID
+(human interface device, in our case a mouse) USB device when it boots
+up.
+
+Eject/unmount the pyboard drive and reset it using the RST switch.
+Your PC should now detect the pyboard as a mouse!
+
+Sending mouse events by hand
+----------------------------
+
+To get the py-mouse to do anything we need to send mouse events to the PC.
+We will first do this manually using the REPL prompt.  Connect to your
+pyboard using your serial program and type the following::
+
+    >>> pyb.hid((0, 10, 0, 0))
+
+Your mouse should move 10 pixels to the right!  In the command above you
+are sending 4 pieces of information: button status, x, y and scroll.  The
+number 10 is telling the PC that the mouse moved 10 pixels in the x direction.
+
+Let's make the mouse oscillate left and right::
+
+    >>> import math
+    >>> def osc(n, d):
+    ...   for i in range(n):
+    ...     pyb.hid((0, int(20 * math.sin(i / 10)), 0, 0))
+    ...     pyb.delay(d)
+    ...
+    >>> osc(100, 50)
+
+The first argument to the function ``osc`` is the number of mouse events to send,
+and the second argument is the delay (in milliseconds) between events.  Try
+playing around with different numbers.
+
+**Excercise: make the mouse go around in a circle.**
+
+Making a mouse with the accelerometer
+-------------------------------------
+
+Now lets make the mouse move based on the angle of the pyboard, using the
+accelerometer.  The following code can be typed directly at the REPL prompt,
+or put in the ``main.py`` file.  Here, we'll put in in ``main.py`` because to do
+that we will learn how to go into safe mode.
+
+At the moment the pyboard is acting as a serial USB device and an HID (a mouse).
+So you cannot access the filesystem to edit your ``main.py`` file.
+
+You also can't edit your ``boot.py`` to get out of HID-mode and back to normal
+mode with a USB drive...
+
+To get around this we need to go into *safe mode*.  This was described in
+the [safe mode tutorial](tut-reset), but we repeat the instructions here:
+
+1. Hold down the USR switch.
+2. While still holding down USR, press and release the RST switch.
+3. The LEDs will then cycle green to orange to green+orange and back again.
+4. Keep holding down USR until *only the orange LED is lit*, and then let
+   go of the USR switch.
+5. The orange LED should flash quickly 4 times, and then turn off.  
+6. You are now in safe mode.
+
+In safe mode, the ``boot.py`` and ``main.py`` files are not executed, and so
+the pyboard boots up with default settings.  This means you now have access
+to the filesystem (the USB drive should appear), and you can edit ``main.py``.
+(Leave ``boot.py`` as-is, because we still want to go back to HID-mode after
+we finish editting ``main.py``.)
+
+In ``main.py`` put the following code::
+
+    import pyb
+
+    switch = pyb.Switch()
+    accel = pyb.Accel()
+
+    while not switch():
+        pyb.hid((0, accel.x(), accel.y(), 0))
+        pyb.delay(20)
+
+Save your file, eject/unmount your pyboard drive, and reset it using the RST
+switch.  It should now act as a mouse, and the angle of the board will move
+the mouse around.  Try it out, and see if you can make the mouse stand still!
+
+Press the USR switch to stop the mouse motion.
+
+You'll note that the y-axis is inverted.  That's easy to fix: just put a
+minus sign in front of the y-coordinate in the ``pyb.hid()`` line above.
+
+Restoring your pyboard to normal
+--------------------------------
+
+If you leave your pyboard as-is, it'll behave as a mouse everytime you plug
+it in.  You probably want to change it back to normal.  To do this you need
+to first enter safe mode (see above), and then edit the ``boot.py`` file.
+In the ``boot.py`` file, comment out (put a # in front of) the line with the
+``CDC+HID`` setting, so it looks like::
+
+    #pyb.usb_mode('CDC+HID') # act as a serial device and a mouse
+
+Save your file, eject/unmount the drive, and reset the pyboard.  It is now
+back to normal operating mode.

drivers/README.md

@@ -0,0 +1,2 @@
+This directory contains drivers for specific hardware.  The drivers are
+intended to work across multiple ports.

drivers/cc3000/inc/cc3000_common.h

@@ -3,14 +3,6 @@
 *  cc3000_common.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -40,15 +32,21 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __COMMON_H__
-#define __COMMON_H__
+#ifndef __CC3000_COMMON_H__
+#define __CC3000_COMMON_H__
+
+#include "data_types.h"
 
 //******************************************************************************
 // Include files
 //******************************************************************************
-//#include <stdlib.h>
-//#include <errno.h>
-//#include <stdint.h>
+#include <stdlib.h>
+#include <stdint.h>
+
+//*****************************************************************************
+// Prefix exported names to avoid name clash
+//*****************************************************************************
+#define CC3000_EXPORT(name) cc3000_ ## name
 
 //*****************************************************************************
 //
@@ -60,6 +58,8 @@
 extern "C" {
 #endif
 
+extern int CC3000_EXPORT(errno);
+
 //*****************************************************************************
 //                  ERROR CODES
 //*****************************************************************************
@@ -78,8 +78,6 @@ extern "C" {
 #define	MAC_ADDR_LEN	(6)
 
 #define	SP_PORTION_SIZE	(32)
-
-// #define CC3000_TINY_DRIVER
   
 /*Defines for minimal and maximal RX buffer size. This size includes the spi 
   header and hci header.
@@ -154,8 +152,8 @@ extern "C" {
   
 #ifndef CC3000_TINY_DRIVER
   
-	#define CC3000_RX_BUFFER_SIZE   (CC3000_MINIMAL_RX_SIZE)
-	#define CC3000_TX_BUFFER_SIZE   (CC3000_MINIMAL_TX_SIZE)
+	#define CC3000_RX_BUFFER_SIZE   (CC3000_MAXIMAL_RX_SIZE)
+	#define CC3000_TX_BUFFER_SIZE   (CC3000_MAXIMAL_TX_SIZE)
   
 //if defined TINY DRIVER we use smaller RX and TX buffer in order to minimize RAM consumption
 #else
@@ -167,13 +165,9 @@ extern "C" {
 //*****************************************************************************
 //                  Compound Types
 //*****************************************************************************
-#ifdef __AVR__
-typedef unsigned long time_t;  /* KTown: Updated to be compatible with Arduino Time.h */
-#else
-typedef long time_t;
-#endif
-typedef unsigned long clock_t;
-typedef long suseconds_t;
+typedef INT32 time_t;
+typedef UINT32 clock_t;
+typedef INT32 suseconds_t;
 
 typedef struct timeval timeval;
 
@@ -183,28 +177,28 @@ struct timeval
     suseconds_t    tv_usec;                 /* microseconds */
 };
 
-typedef char *(*tFWPatches)(unsigned long *usLength);
+typedef CHAR *(*tFWPatches)(UINT32 *usLength);
 
-typedef char *(*tDriverPatches)(unsigned long *usLength);
+typedef CHAR *(*tDriverPatches)(UINT32 *usLength);
 
-typedef char *(*tBootLoaderPatches)(unsigned long *usLength);
+typedef CHAR *(*tBootLoaderPatches)(UINT32 *usLength);
 
-typedef void (*tWlanCB)(long event_type, char * data, unsigned char length );
+typedef void (*tWlanCB)(INT32 event_type, CHAR * data, UINT8 length );
 
-typedef long (*tWlanReadInteruptPin)(void);
+typedef INT32 (*tWlanReadInteruptPin)(void);
 
 typedef void (*tWlanInterruptEnable)(void);
 
 typedef void (*tWlanInterruptDisable)(void);
 
-typedef void (*tWriteWlanPin)(unsigned char val);
+typedef void (*tWriteWlanPin)(UINT8 val);
 
 typedef struct
 {
-	unsigned short	 usRxEventOpcode;
-	unsigned short	 usEventOrDataReceived;
-	unsigned char 	*pucReceivedData;
-	unsigned char 	*pucTxCommandBuffer;
+	UINT16	 usRxEventOpcode;
+	UINT16	 usEventOrDataReceived;
+	UINT8 	*pucReceivedData;
+	UINT8 	*pucTxCommandBuffer;
 
 	tFWPatches 			sFWPatches;
 	tDriverPatches 		sDriverPatches;
@@ -215,16 +209,16 @@ typedef struct
     tWlanInterruptDisable WlanInterruptDisable;
     tWriteWlanPin         WriteWlanPin;
 
-	signed long		 slTransmitDataError;
-	unsigned short	 usNumberOfFreeBuffers;
-	unsigned short	 usSlBufferLength;
-	unsigned short	 usBufferSize;
-	unsigned short	 usRxDataPending;
+	INT32		 slTransmitDataError;
+	UINT16	 usNumberOfFreeBuffers;
+	UINT16	 usSlBufferLength;
+	UINT16	 usBufferSize;
+	UINT16	 usRxDataPending;
 
-	unsigned long    NumberOfSentPackets;
-	unsigned long    NumberOfReleasedPackets;
+	UINT32    NumberOfSentPackets;
+	UINT32    NumberOfReleasedPackets;
 
-	unsigned char	 InformHostOnTxComplete;
+	UINT8	 InformHostOnTxComplete;
 }sSimplLinkInformation;
 
 extern volatile sSimplLinkInformation tSLInformation;
@@ -250,7 +244,7 @@ extern volatile sSimplLinkInformation tSLInformation;
 //
 //*****************************************************************************
 
-extern void SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams);
+extern void SimpleLinkWaitEvent(UINT16 usOpcode, void *pRetParams);
 
 //*****************************************************************************
 //
@@ -268,7 +262,7 @@ extern void SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams);
 //
 //*****************************************************************************
 
-extern void SimpleLinkWaitData(uint8_t *pBuf, uint8_t *from, uint8_t *fromlen);
+extern void SimpleLinkWaitData(UINT8 *pBuf, UINT8 *from, UINT8 *fromlen);
 
 //*****************************************************************************
 //
@@ -284,7 +278,7 @@ extern void SimpleLinkWaitData(uint8_t *pBuf, uint8_t *from, uint8_t *fromlen);
 //
 //*****************************************************************************
 
-extern uint8_t* UINT32_TO_STREAM_f (uint8_t *p, uint32_t u32);
+extern UINT8* UINT32_TO_STREAM_f (UINT8 *p, UINT32 u32);
 
 //*****************************************************************************
 //
@@ -300,7 +294,7 @@ extern uint8_t* UINT32_TO_STREAM_f (uint8_t *p, uint32_t u32);
 //
 //*****************************************************************************
 
-extern uint8_t* UINT16_TO_STREAM_f (uint8_t *p, uint16_t u16);
+extern UINT8* UINT16_TO_STREAM_f (UINT8 *p, UINT16 u16);
 
 //*****************************************************************************
 //
@@ -316,7 +310,7 @@ extern uint8_t* UINT16_TO_STREAM_f (uint8_t *p, uint16_t u16);
 //
 //*****************************************************************************
 
-extern uint16_t STREAM_TO_UINT16_f(char* p, uint16_t offset);
+extern UINT16 STREAM_TO_UINT16_f(CHAR* p, UINT16 offset);
 
 //*****************************************************************************
 //
@@ -332,21 +326,7 @@ extern uint16_t STREAM_TO_UINT16_f(char* p, uint16_t offset);
 //
 //*****************************************************************************
 
-extern uint32_t STREAM_TO_UINT32_f(char* p, uint16_t offset);
-
-
-//*****************************************************************************
-//
-//!  cc3k_int_poll
-//!
-//!  \brief               checks if the interrupt pin is low
-//!                       just in case the hardware missed a falling edge
-//!                       function is in ccspi.cpp
-//
-//*****************************************************************************
-
-extern void cc3k_int_poll();
-
+extern UINT32 STREAM_TO_UINT32_f(CHAR* p, UINT16 offset);
 
 
 //*****************************************************************************
@@ -361,14 +341,14 @@ extern void cc3k_int_poll();
 //This macro is used for copying 32 bit to stream while converting to little endian format.
 #define UINT32_TO_STREAM(_p, _u32)	(UINT32_TO_STREAM_f(_p, _u32))
 //This macro is used for copying a specified value length bits (l) to stream while converting to little endian format.
-#define ARRAY_TO_STREAM(p, a, l) 	{register short _i; for (_i = 0; _i < l; _i++) *(p)++ = ((uint8_t *) a)[_i];}
+#define ARRAY_TO_STREAM(p, a, l) 	{register INT16 _i; for (_i = 0; _i < l; _i++) *(p)++ = ((UINT8 *) a)[_i];}
 //This macro is used for copying received stream to 8 bit in little endian format.
-#define STREAM_TO_UINT8(_p, _offset, _u8)	{_u8 = (uint8_t)(*(_p + _offset));}
+#define STREAM_TO_UINT8(_p, _offset, _u8)	{_u8 = (UINT8)(*(_p + _offset));}
 //This macro is used for copying received stream to 16 bit in little endian format.
 #define STREAM_TO_UINT16(_p, _offset, _u16)	{_u16 = STREAM_TO_UINT16_f(_p, _offset);}
 //This macro is used for copying received stream to 32 bit in little endian format.
 #define STREAM_TO_UINT32(_p, _offset, _u32)	{_u32 = STREAM_TO_UINT32_f(_p, _offset);}
-#define STREAM_TO_STREAM(p, a, l) 	{register short _i; for (_i = 0; _i < l; _i++) *(a)++= ((uint8_t *) p)[_i];}
+#define STREAM_TO_STREAM(p, a, l) 	{register INT16 _i; for (_i = 0; _i < l; _i++) *(a)++= ((UINT8 *) p)[_i];}
 
 
 
@@ -382,4 +362,4 @@ extern void cc3k_int_poll();
 }
 #endif // __cplusplus
 
-#endif // __COMMON_H__
+#endif // __CC3000_COMMON_H__

drivers/cc3000/inc/ccspi.h

@@ -3,14 +3,6 @@
 *  spi.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -20,40 +12,43 @@
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
-*    documentation and/or other materials provided with the
+*    documentation and/or other materials provided with the   
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
-*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
 
 
-#ifndef __SPI_H__
-#define __SPI_H__
+#ifndef __CC3000_SPI_H__
+#define __CC3000_SPI_H__
 
-//#include <string.h>
-//#include <stdlib.h>
-//#include <stdio.h>
-
-//#include "wlan.h"
+//*****************************************************************************
+//
+// If building with a C++ compiler, make all of the definitions in this header
+// have a C binding.
+//
+//*****************************************************************************
+#ifdef  __cplusplus
+extern "C" {
+#endif
 
 typedef void (*gcSpiHandleRx)(void *p);
 typedef void (*gcSpiHandleTx)(void);
-
 extern unsigned char wlan_tx_buffer[];
 
 //*****************************************************************************
@@ -61,23 +56,29 @@ extern unsigned char wlan_tx_buffer[];
 // Prototypes for the APIs.
 //
 //*****************************************************************************
-extern void SpiInit(void);
+
+// the arguments must be of type pin_obj_t* and SPI_HandleTypeDef*
+extern void SpiInit(void *spi, const void *pin_cs, const void *pin_en, const void *pin_irq);
+
 extern void SpiOpen(gcSpiHandleRx pfRxHandler);
 extern void SpiClose(void);
-extern long SpiWrite(unsigned char *pUserBuffer, unsigned short usLength);
+extern void SpiPauseSpi(void);
 extern void SpiResumeSpi(void);
+extern long SpiWrite(unsigned char *pUserBuffer, unsigned short usLength);
+extern void SpiConfigureHwMapping(void);
 extern void SpiCleanGPIOISR(void);
-extern long TXBufferIsEmpty(void);
-extern long RXBufferIsEmpty(void);
-extern void CC3000_UsynchCallback(long lEventType, char * data, unsigned char length);
-extern void WriteWlanPin( unsigned char val );
+extern void SSIConfigure(unsigned long ulSSIFreq, unsigned long bForceGpioConfiguration, unsigned long uiReconfigureSysClock);
+extern int init_spi(void);
 extern long ReadWlanInterruptPin(void);
-extern void WlanInterruptEnable();
-extern void WlanInterruptDisable();
-extern char *sendDriverPatch(unsigned long *Length);
-extern char *sendBootLoaderPatch(unsigned long *Length);
-extern char *sendWLFWPatch(unsigned long *Length);
-extern void SpiIntGPIOHandler(void);
+extern void WriteWlanPin(unsigned char val);
+//*****************************************************************************
+//
+// Mark the end of the C bindings section for C++ compilers.
+//
+//*****************************************************************************
+#ifdef  __cplusplus
+}
+#endif // __cplusplus
 
 #endif
 

drivers/cc3000/inc/data_types.h

@@ -1,6 +1,6 @@
 /*****************************************************************************
 *
-*  host_driver_version.h  - CC3000 Host Driver Implementation.
+*  data_types.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
 *  Redistribution and use in source and binary forms, with or without
@@ -32,24 +32,76 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __HOST_DRIVER_VERSION_H__
-#define __HOST_DRIVER_VERSION_H__
+#ifndef __CC3000_DATA_TYPES__
+#define __CC3000_DATA_TYPES__
 
-#define DRIVER_VERSION_NUMBER   13
+//*****************************************************************************
+//
+// If building with a C++ compiler, make all of the definitions in this header
+// have a C binding.
+//
+//*****************************************************************************
+#ifdef	__cplusplus
+extern "C" {
+#endif
 
 
+#ifndef NULL
+#define NULL        		(0)
+#endif
 
-#endif // __VERSION_H__
-
+#ifndef FALSE
+#define FALSE       		(0)
+#endif
 
+#ifndef TRUE
+#define TRUE        		(!FALSE)
+#endif
 
+#ifndef OK
+#define OK          		(0)
+#endif
 
+#ifndef _INT8
+#define _INT8
+typedef signed char   		INT8;
+#endif
 
+#ifndef _UINT8
+#define _UINT8
+typedef unsigned char   	UINT8;
+#endif
 
+#ifndef _INT16
+#define _INT16
+typedef signed short  		INT16;
+#endif
 
+#ifndef _UINT16
+#define _UINT16
+typedef unsigned short   	UINT16;
+#endif
 
+#ifndef _BOOLEAN
+#define _BOOLEAN
+typedef unsigned char   	BOOLEAN;
+#endif
 
+#ifndef _INT32
+#define _INT32
+typedef signed long   		INT32;
+#endif
 
+#ifndef _UINT32
+#define _UINT32
+typedef unsigned long   	UINT32;
+#endif
 
+typedef int             	INT;
+typedef char            	CHAR;
 
+#ifdef	__cplusplus
+}
+#endif /* __cplusplus */
 
+#endif /* __CC3000_DATA_TYPES__ */

drivers/cc3000/inc/evnt_handler.h

@@ -3,14 +3,6 @@
 *  evnt_handler.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -40,9 +32,8 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __EVENT_HANDLER_H__
-#define __EVENT_HANDLER_H__
-
+#ifndef __CC3000_EVENT_HANDLER_H__
+#define __CC3000_EVENT_HANDLER_H__
 #include "hci.h"
 #include "socket.h"
 
@@ -76,7 +67,7 @@ extern "C" {
 //!                  event handler from global array of handlers pointers
 //
 //*****************************************************************************
-extern unsigned char *hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen);
+extern UINT8 *hci_event_handler(void *pRetParams, UINT8 *from, UINT8 *fromlen);
 
 //*****************************************************************************
 //
@@ -90,7 +81,7 @@ extern unsigned char *hci_event_handler(void *pRetParams, unsigned char *from, u
 //!  @brief              Handle unsolicited events
 //
 //*****************************************************************************
-extern long hci_unsol_event_handler(char *event_hdr);
+extern INT32 hci_unsol_event_handler(CHAR *event_hdr);
 
 //*****************************************************************************
 //
@@ -104,9 +95,9 @@ extern long hci_unsol_event_handler(char *event_hdr);
 //!                  corresponding event handler.
 //
 //*****************************************************************************
-extern long hci_unsolicited_event_handler(void);
+extern INT32 hci_unsolicited_event_handler(void);
 
-#define M_BSD_RESP_PARAMS_OFFSET(hci_event_hdr)((char *)(hci_event_hdr) + HCI_EVENT_HEADER_SIZE)
+#define M_BSD_RESP_PARAMS_OFFSET(hci_event_hdr)((CHAR *)(hci_event_hdr) + HCI_EVENT_HEADER_SIZE)
 
 #define SOCKET_STATUS_ACTIVE       0
 #define SOCKET_STATUS_INACTIVE     1
@@ -116,15 +107,15 @@ extern long hci_unsolicited_event_handler(void);
 #define M_IS_VALID_SD(sd) ((0 <= (sd)) && ((sd) <= 7))
 #define M_IS_VALID_STATUS(status) (((status) == SOCKET_STATUS_ACTIVE)||((status) == SOCKET_STATUS_INACTIVE))
 
-extern unsigned long socket_active_status;
+extern UINT32 socket_active_status;
 
-extern void set_socket_active_status(long Sd, long Status);
-extern long get_socket_active_status(long Sd);
+extern void set_socket_active_status(INT32 Sd, INT32 Status);
+extern INT32 get_socket_active_status(INT32 Sd);
 
 typedef struct _bsd_accept_return_t
 {
-    long             iSocketDescriptor;
-    long             iStatus;
+    INT32             iSocketDescriptor;
+    INT32             iStatus;
     sockaddr   		tSocketAddress;
     
 } tBsdReturnParams;
@@ -132,9 +123,9 @@ typedef struct _bsd_accept_return_t
 
 typedef struct _bsd_read_return_t
 {
-    long             iSocketDescriptor;
-    long             iNumberOfBytes;
-    unsigned long	 uiFlags;
+    INT32             iSocketDescriptor;
+    INT32             iNumberOfBytes;
+    UINT32	 uiFlags;
 } tBsdReadReturnParams;
 
 #define BSD_RECV_FROM_FROMLEN_OFFSET	(4)
@@ -143,23 +134,23 @@ typedef struct _bsd_read_return_t
 
 typedef struct _bsd_select_return_t
 {
-    long					iStatus;
-	unsigned long 			uiRdfd;
-	unsigned long 			uiWrfd;
-	unsigned long 			uiExfd;
+    INT32					iStatus;
+	UINT32 			uiRdfd;
+	UINT32 			uiWrfd;
+	UINT32 			uiExfd;
 } tBsdSelectRecvParams;
 
 
 typedef struct _bsd_getsockopt_return_t
 {
-	unsigned char			ucOptValue[4];
-	char						iStatus;
+	UINT8			ucOptValue[4];
+	CHAR						iStatus;
 } tBsdGetSockOptReturnParams;
 
 typedef struct _bsd_gethostbyname_return_t
 {
-    long             retVal;
-    long             outputAddress;
+    INT32             retVal;
+    INT32             outputAddress;
 } tBsdGethostbynameParams;
 
 //*****************************************************************************
@@ -171,5 +162,5 @@ typedef struct _bsd_gethostbyname_return_t
 }
 #endif // __cplusplus
 
-#endif // __EVENT_HANDLER_H__
+#endif // __CC3000_EVENT_HANDLER_H__
 

drivers/cc3000/inc/hci.h

@@ -3,14 +3,6 @@
 *  hci.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -40,8 +32,8 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __HCI_H__
-#define __HCI_H__
+#ifndef __CC3000_HCI_H__
+#define __CC3000_HCI_H__
 
 #include "cc3000_common.h"
 
@@ -110,6 +102,7 @@ extern "C" {
 #define  HCI_CMND_RECVFROM      0x100D
 #define  HCI_CMND_GETHOSTNAME   0x1010
 #define  HCI_CMND_MDNS_ADVERTISE	   0x1011
+#define  HCI_CMND_GETMSSVALUE		0x1012
 
 
 #define HCI_DATA_BASE								0x80
@@ -175,7 +168,8 @@ extern "C" {
 #define  HCI_EVNT_GETSOCKOPT          HCI_CMND_GETSOCKOPT
 #define  HCI_EVNT_BSD_GETHOSTBYNAME   HCI_CMND_GETHOSTNAME
 #define  HCI_EVNT_MDNS_ADVERTISE   HCI_CMND_MDNS_ADVERTISE
- 
+#define  HCI_EVNT_GETMSSVALUE		HCI_CMND_GETMSSVALUE	
+
 #define  HCI_EVNT_SEND          0x1003
 #define  HCI_EVNT_WRITE         0x100E
 #define  HCI_EVNT_SENDTO        0x100F
@@ -261,9 +255,9 @@ extern "C" {
 //!  @brief               Initiate an HCI command.
 //
 //*****************************************************************************
-extern unsigned short hci_command_send(unsigned short usOpcode, 
-                                   unsigned char *ucArgs,
-                                   unsigned char ucArgsLength);
+extern UINT16 hci_command_send(UINT16 usOpcode, 
+                                   UINT8 *ucArgs,
+                                   UINT8 ucArgsLength);
  
 
 //*****************************************************************************
@@ -281,12 +275,12 @@ extern unsigned short hci_command_send(unsigned short usOpcode,
 //!  @brief              Initiate an HCI data write operation
 //
 //*****************************************************************************
-extern long hci_data_send(unsigned char ucOpcode,
-                                      unsigned char *ucArgs,
-                                      unsigned short usArgsLength,
-                                      unsigned short usDataLength,
-                                      const unsigned char *ucTail,
-                                      unsigned short usTailLength);
+extern INT32 hci_data_send(UINT8 ucOpcode,
+                                      UINT8 *ucArgs,
+                                      UINT16 usArgsLength,
+                                      UINT16 usDataLength,
+                                      const UINT8 *ucTail,
+                                      UINT16 usTailLength);
 
 
 //*****************************************************************************
@@ -303,8 +297,8 @@ extern long hci_data_send(unsigned char ucOpcode,
 //!  @brief              Prepare HCI header and initiate an HCI data write operation
 //
 //*****************************************************************************
-extern void hci_data_command_send(unsigned short usOpcode, unsigned char *pucBuff,
-                     unsigned char ucArgsLength, unsigned short ucDataLength);
+extern void hci_data_command_send(UINT16 usOpcode, UINT8 *pucBuff,
+                     UINT8 ucArgsLength, UINT16 ucDataLength);
 
 //*****************************************************************************
 //
@@ -320,7 +314,7 @@ extern void hci_data_command_send(unsigned short usOpcode, unsigned char *pucBuf
 //!  @brief               Prepare HCI header and initiate an HCI patch write operation
 //
 //*****************************************************************************
-extern void hci_patch_send(unsigned char ucOpcode, unsigned char *pucBuff, char *patch, unsigned short usDataLength);
+extern void hci_patch_send(UINT8 ucOpcode, UINT8 *pucBuff, CHAR *patch, UINT16 usDataLength);
 
 
 
@@ -333,4 +327,4 @@ extern void hci_patch_send(unsigned char ucOpcode, unsigned char *pucBuff, char
 }
 #endif // __cplusplus
 
-#endif // __HCI_H__
+#endif // __CC3000_HCI_H__

drivers/cc3000/inc/host_driver_version.h

@@ -32,24 +32,9 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __HOST_DRIVER_VERSION_H__
-#define __HOST_DRIVER_VERSION_H__
-
-#define DRIVER_VERSION_NUMBER   13
-
-
-
-#endif // __VERSION_H__
-
-
-
-
-
-
-
-
-
-
-
+#ifndef __CC3000_HOST_DRIVER_VERSION_H__
+#define __CC3000_HOST_DRIVER_VERSION_H__
 
+#define DRIVER_VERSION_NUMBER   15
 
+#endif // __CC3000_HOST_DRIVER_VERSION_H__

drivers/cc3000/inc/inet_ntop.h

@@ -0,0 +1,4 @@
+#ifndef __INET_NTOP_H
+#define __INET_NTOP_H
+char *inet_ntop(int af, const void *addr, char *buf, size_t size);
+#endif /* __INET_NTOP_H */

drivers/cc3000/inc/inet_pton.h

@@ -0,0 +1,4 @@
+#ifndef __INET_PTON_H
+#define __INET_PTON_H
+int inet_pton(int, const char *, void *);
+#endif /* __INET_PTON_H */

drivers/cc3000/inc/netapp.h

@@ -3,14 +3,6 @@
 *  netapp.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -40,8 +32,10 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __NETAPP_H__
-#define	__NETAPP_H__
+#ifndef __CC3000_NETAPP_H__
+#define	__CC3000_NETAPP_H__
+
+#include "data_types.h"
 
 //*****************************************************************************
 //
@@ -62,33 +56,33 @@ extern "C" {
 
 typedef struct _netapp_dhcp_ret_args_t
 {
-    unsigned char aucIP[4];
-	unsigned char aucSubnetMask[4];
-	unsigned char aucDefaultGateway[4];
-	unsigned char aucDHCPServer[4];
-	unsigned char aucDNSServer[4];
+    UINT8 aucIP[4];
+	UINT8 aucSubnetMask[4];
+	UINT8 aucDefaultGateway[4];
+	UINT8 aucDHCPServer[4];
+	UINT8 aucDNSServer[4];
 }tNetappDhcpParams;
 
 typedef struct _netapp_ipconfig_ret_args_t
 {
-    unsigned char aucIP[4];
-	unsigned char aucSubnetMask[4];
-	unsigned char aucDefaultGateway[4];
-	unsigned char aucDHCPServer[4];
-	unsigned char aucDNSServer[4];
-	unsigned char uaMacAddr[6];
-	unsigned char uaSSID[32];
+    UINT8 aucIP[4];
+	UINT8 aucSubnetMask[4];
+	UINT8 aucDefaultGateway[4];
+	UINT8 aucDHCPServer[4];
+	UINT8 aucDNSServer[4];
+	UINT8 uaMacAddr[6];
+	UINT8 uaSSID[32];
 }tNetappIpconfigRetArgs;
 
 
 /*Ping send report parameters*/
 typedef struct _netapp_pingreport_args
 {
-	unsigned long packets_sent;
-	unsigned long packets_received;
-	unsigned long min_round_time;
-	unsigned long max_round_time;
-	unsigned long avg_round_time;
+	UINT32 packets_sent;
+	UINT32 packets_received;
+	UINT32 min_round_time;
+	UINT32 max_round_time;
+	UINT32 avg_round_time;
 } netapp_pingreport_args_t;
 
 
@@ -106,7 +100,7 @@ typedef struct _netapp_pingreport_args
 //!                over resets.
 //
 //*****************************************************************************
-extern long  netapp_config_mac_adrress( unsigned char *mac );
+extern INT32  netapp_config_mac_adrress( UINT8 *mac );
 
 //*****************************************************************************
 //
@@ -134,7 +128,7 @@ extern long  netapp_config_mac_adrress( unsigned char *mac );
 //!               AP was established. 
 //!
 //*****************************************************************************
-extern 	long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsigned long *aucDefaultGateway, unsigned long *aucDNSServer);
+extern 	INT32 netapp_dhcp(UINT32 *aucIP, UINT32 *aucSubnetMask,UINT32 *aucDefaultGateway, UINT32 *aucDNSServer);
 
 
 
@@ -147,7 +141,7 @@ extern 	long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsi
 //!                     0 or 0xffffffff == infinity lease timeout.
 //!                     Resolution:10 seconds. Influence: only after 
 //!                     reconnecting to the AP. 
-//!                     Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds.
+//!                     Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 seconds.
 //!                     The parameter is saved into the CC3000 NVMEM. 
 //!                     The default value on CC3000 is 14400 seconds.
 //!	 
@@ -156,7 +150,7 @@ extern 	long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsi
 //!                     the end of the timeout. 
 //!                     Range: [0-0xffffffff] seconds, 0 == infinity ARP timeout
 //!                     Resolution: 10 seconds. Influence: on runtime.
-//!                     Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 seconds
+//!                     Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 seconds
 //!                     The parameter is saved into the CC3000 NVMEM. 
 //!	                    The default value on CC3000 is 3600 seconds.
 //!
@@ -164,7 +158,7 @@ extern 	long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsi
 //!                         Range: [0-0xffffffff] seconds, 0 == infinity timeout
 //!                         Resolution: 10 seconds.
 //!                         Influence: on runtime.
-//!                         Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec
+//!                         Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 sec
 //!                         The parameter is saved into the CC3000 NVMEM. 
 //!                         The default value on CC3000 is 10 seconds.
 //!
@@ -173,7 +167,7 @@ extern 	long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsi
 //!                          end of the socket timeout the socket will be closed
 //!                          Range: [0-0xffffffff] sec, 0 == infinity timeout.
 //!                          Resolution: 10 seconds. Influence: on runtime.
-//!                          Minimal bound value: MIN_TIMER_VAL_SECONDS - 20 sec
+//!                          Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 sec
 //!                          The parameter is saved into the CC3000 NVMEM. 
 //!	                         The default value on CC3000 is 60 seconds.
 //!
@@ -183,12 +177,12 @@ extern 	long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsi
 //!               DHCP lease timeout, ARP  refresh timeout, keepalive event 
 //!               timeout and socket inactivity timeout 
 //!	 
-//! @note         If a parameter set to non zero value which is less than 20s,
-//!               it will be set automatically to 20s.
+//! @note         If a parameter set to non zero value which is less than 10s,
+//!               it will be set automatically to 10s.
 //!
 //*****************************************************************************
- #ifndef CC3000_TINY_DRIVER
-extern long netapp_timeout_values(unsigned long *aucDHCP, unsigned long *aucARP,unsigned long *aucKeepalive,	unsigned long *aucInactivity);
+#ifndef CC3000_TINY_DRIVER
+extern INT32 netapp_timeout_values(UINT32 *aucDHCP, UINT32 *aucARP, UINT32 *aucKeepalive, UINT32 *aucInactivity);
 #endif
 
 //*****************************************************************************
@@ -213,7 +207,7 @@ extern long netapp_timeout_values(unsigned long *aucDHCP, unsigned long *aucARP,
 //*****************************************************************************
 
  #ifndef CC3000_TINY_DRIVER
-extern long netapp_ping_send(uint32_t *ip, uint32_t ulPingAttempts, uint32_t ulPingSize, uint32_t ulPingTimeout);
+extern INT32 netapp_ping_send(UINT32 *ip, UINT32 ulPingAttempts, UINT32 ulPingSize, UINT32 ulPingTimeout);
 #endif
 
 //*****************************************************************************
@@ -230,7 +224,7 @@ extern long netapp_ping_send(uint32_t *ip, uint32_t ulPingAttempts, uint32_t ulP
 //*****************************************************************************
 
 #ifndef CC3000_TINY_DRIVER
-extern long netapp_ping_stop();
+extern INT32 netapp_ping_stop();
 #endif
 //*****************************************************************************
 //
@@ -301,7 +295,7 @@ extern void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig );
 //*****************************************************************************
 
 #ifndef CC3000_TINY_DRIVER
-extern long netapp_arp_flush();
+extern INT32 netapp_arp_flush();
 #endif
 
 
@@ -325,7 +319,7 @@ extern long netapp_arp_flush();
 
 
 #ifndef CC3000_TINY_DRIVER
-long netapp_set_debug_level(unsigned long ulLevel);
+INT32 netapp_set_debug_level(UINT32 ulLevel);
 #endif
 //*****************************************************************************
 //
@@ -345,5 +339,5 @@ long netapp_set_debug_level(unsigned long ulLevel);
 }
 #endif // __cplusplus
 
-#endif	// __NETAPP_H__
+#endif	// __CC3000_NETAPP_H__
 

drivers/cc3000/inc/nvmem.h

@@ -3,14 +3,6 @@
 *  nvmem.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -40,8 +32,8 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __NVRAM_H__
-#define __NVRAM_H__
+#ifndef __CC3000_NVRAM_H__
+#define __CC3000_NVRAM_H__
 
 #include "cc3000_common.h"
 
@@ -107,7 +99,7 @@ extern "C" {
 //!  @param  ulOffset    ulOffset in file from where to read  
 //!  @param  buff        output buffer pointer
 //!
-//!  @return       number of bytes read, otherwise error.
+//!  @return       on success 0, error otherwise.
 //!
 //!  @brief       Reads data from the file referred by the ulFileId parameter. 
 //!               Reads data from file ulOffset till length. Err if the file can't
@@ -115,7 +107,7 @@ extern "C" {
 //!	 
 //*****************************************************************************
 
-extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsigned long offset, unsigned char *buff);
+extern INT32 nvmem_read(UINT32 file_id, UINT32 length, UINT32 offset, UINT8 *buff);
 
 //*****************************************************************************
 //
@@ -139,7 +131,7 @@ extern signed long nvmem_read(unsigned long file_id, unsigned long length, unsig
 //!	 
 //*****************************************************************************
 
-extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, unsigned long ulEntryOffset, unsigned char *buff);
+extern INT32 nvmem_write(UINT32 ulFileId, UINT32 ulLength, UINT32 ulEntryOffset, UINT8 *buff);
 
 
 //*****************************************************************************
@@ -154,7 +146,7 @@ extern signed long nvmem_write(unsigned long ulFileId, unsigned long ulLength, u
 //!               mac address as appears over the air (OUI first)
 //!	 
 //*****************************************************************************
-extern	unsigned char nvmem_set_mac_address(unsigned char *mac);
+extern UINT8 nvmem_set_mac_address(UINT8 *mac);
 
 
 //*****************************************************************************
@@ -169,7 +161,7 @@ extern	unsigned char nvmem_set_mac_address(unsigned char *mac);
 //!               mac address as appears over the air (OUI first)
 //!	 
 //*****************************************************************************
-extern	unsigned char nvmem_get_mac_address(unsigned char *mac);
+extern UINT8 nvmem_get_mac_address(UINT8 *mac);
 
 
 //*****************************************************************************
@@ -189,7 +181,7 @@ extern	unsigned char nvmem_get_mac_address(unsigned char *mac);
 //!              applied in SP_PORTION_SIZE bytes portions.
 //!	 
 //*****************************************************************************
-extern	unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spLength, const unsigned char *spData);
+extern UINT8 nvmem_write_patch(UINT32 ulFileId, UINT32 spLength, const UINT8 *spData);
 
 
 //*****************************************************************************
@@ -206,7 +198,7 @@ extern	unsigned char nvmem_write_patch(unsigned long ulFileId, unsigned long spL
 //!	 
 //*****************************************************************************
 #ifndef CC3000_TINY_DRIVER 
-extern	unsigned char nvmem_read_sp_version(unsigned char* patchVer);
+extern UINT8 nvmem_read_sp_version(UINT8* patchVer);
 #endif
 
 //*****************************************************************************
@@ -231,7 +223,7 @@ extern	unsigned char nvmem_read_sp_version(unsigned char* patchVer);
 //!              set ulNewLen=0.
 //!	 
 //*****************************************************************************
-extern int8_t nvmem_create_entry(unsigned long file_id, unsigned long newlen);
+extern INT32 nvmem_create_entry(UINT32 file_id, UINT32 newlen);
 
 
 //*****************************************************************************
@@ -253,4 +245,4 @@ extern int8_t nvmem_create_entry(unsigned long file_id, unsigned long newlen);
 }
 #endif // __cplusplus
 
-#endif // __NVRAM_H__
+#endif // __CC3000_NVRAM_H__

drivers/cc3000/inc/patch_prog.h

@@ -0,0 +1,11 @@
+#ifndef __CC3000_PATCH_PROG_H__
+#define __CC3000_PATCH_PROG_H__
+extern unsigned short fw_length;
+extern const unsigned char fw_patch[];
+
+extern unsigned short drv_length;
+extern const unsigned char wlan_drv_patch[];
+extern const unsigned char cRMdefaultParams[128];
+
+void patch_prog_start();
+#endif //__CC3000_PATCH_PROG_H__

drivers/cc3000/inc/security.h

@@ -32,8 +32,8 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __SECURITY__
-#define __SECURITY__
+#ifndef __CC3000_SECURITY__
+#define __CC3000_SECURITY__
 
 #include "nvmem.h"
 
@@ -69,7 +69,7 @@ extern "C" {
 //!	 
 //!
 //*****************************************************************************
-extern void aes_encrypt(unsigned char *state, unsigned char *key);
+extern void aes_encrypt(UINT8 *state, UINT8 *key);
 
 //*****************************************************************************
 //
@@ -87,7 +87,7 @@ extern void aes_encrypt(unsigned char *state, unsigned char *key);
 //!	 
 //!
 //*****************************************************************************
-extern void aes_decrypt(unsigned char *state, unsigned char *key);
+extern void aes_decrypt(UINT8 *state, UINT8 *key);
 
 
 //*****************************************************************************
@@ -104,7 +104,7 @@ extern void aes_decrypt(unsigned char *state, unsigned char *key);
 //!	 
 //!
 //*****************************************************************************
-extern signed long aes_read_key(unsigned char *key);
+extern INT32 aes_read_key(UINT8 *key);
 
 //*****************************************************************************
 //
@@ -119,15 +119,10 @@ extern signed long aes_read_key(unsigned char *key);
 //!	 
 //!
 //*****************************************************************************
-extern signed long aes_write_key(unsigned char *key);
+extern INT32 aes_write_key(UINT8 *key);
 
 #endif //CC3000_UNENCRYPTED_SMART_CONFIG
 
-//*****************************************************************************
-//
-// Mark the end of the C bindings section for C++ compilers.
-//
-//*****************************************************************************
 #ifdef  __cplusplus
 }
 #endif // __cplusplus

drivers/cc3000/inc/socket.h

@@ -3,14 +3,6 @@
 *  socket.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -40,9 +32,10 @@
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
-#ifndef __SOCKET_H__
-#define __SOCKET_H__
+#ifndef __CC3000_SOCKET_H__
+#define __CC3000_SOCKET_H__
 
+#include "cc3000_common.h"
 
 //*****************************************************************************
 //
@@ -102,17 +95,11 @@ extern "C" {
 #define  SOCK_ON                0			// socket non-blocking mode	is enabled		
 #define  SOCK_OFF               1			// socket blocking mode is enabled
 
-#define  TCP_NODELAY            0x0001
-#define  TCP_BSDURGENT          0x7000
-
 #define  MAX_PACKET_SIZE        1500
 #define  MAX_LISTEN_QUEUE       4
 
 #define  IOCTL_SOCKET_EVENTMASK
 
-#ifdef ENOBUFS
-#undef ENOBUFS
-#endif
 #define ENOBUFS                 55          // No buffer space available
 
 #define __FD_SETSIZE            32
@@ -124,37 +111,33 @@ extern "C" {
 	
 typedef struct _in_addr_t
 {
-    unsigned long s_addr;                   // load with inet_aton()
+    UINT32 s_addr;                   // load with inet_aton()
 } in_addr;
 
 typedef struct _sockaddr_t
 {
-    unsigned short int    sa_family;
-    unsigned char     sa_data[14];
+    UINT16   sa_family;
+    UINT8     sa_data[14];
 } sockaddr;
 
 typedef struct _sockaddr_in_t
 {
-    short            sin_family;            // e.g. AF_INET
-    unsigned short   sin_port;              // e.g. htons(3490)
+    INT16            sin_family;            // e.g. AF_INET
+    UINT16   sin_port;              // e.g. htons(3490)
     in_addr          sin_addr;              // see struct in_addr, below
-    char             sin_zero[8];           // zero this if you want to
+    CHAR             sin_zero[8];           // zero this if you want to
 } sockaddr_in;
 
-typedef unsigned long socklen_t;
+typedef UINT32 socklen_t;
 
-// The fd_set member is required to be an array of longs.
-typedef long int __fd_mask;
+// The fd_set member is required to be an array of INT32s.
+typedef INT32 __fd_mask;
 
 // It's easier to assume 8-bit bytes than to get CHAR_BIT.
 #define __NFDBITS               (8 * sizeof (__fd_mask))
 #define __FDELT(d)              ((d) / __NFDBITS)
 #define __FDMASK(d)             ((__fd_mask) 1 << ((d) % __NFDBITS))
 
-#ifdef fd_set
-#undef fd_set  // for compatibility with newlib, which defines fd_set
-#endif
-
 // fd_set for select and pselect.
 typedef struct
 {
@@ -166,7 +149,7 @@ typedef struct
 //   the array isn't too big.
 #define __FD_ZERO(set)                               \
   do {                                                \
-    unsigned int __i;                                 \
+    UINT16 __i;                                 \
     fd_set *__arr = (set);                            \
     for (__i = 0; __i < sizeof (fd_set) / sizeof (__fd_mask); ++__i) \
       __FDS_BITS (__arr)[__i] = 0;                    \
@@ -176,18 +159,6 @@ typedef struct
 #define __FD_ISSET(d, set)     (__FDS_BITS (set)[__FDELT (d)] & __FDMASK (d))
 
 // Access macros for 'fd_set'.
-#ifdef FD_SET
-#undef FD_SET
-#endif
-#ifdef FD_CLR
-#undef FD_CLR
-#endif
-#ifdef FD_ISSET
-#undef FD_ISSET
-#endif
-#ifdef FD_ZERO
-#undef FD_ZERO
-#endif
 #define FD_SET(fd, fdsetp)      __FD_SET (fd, fdsetp)
 #define FD_CLR(fd, fdsetp)      __FD_CLR (fd, fdsetp)
 #define FD_ISSET(fd, fdsetp)    __FD_ISSET (fd, fdsetp)
@@ -195,16 +166,16 @@ typedef struct
 
 //Use in case of Big Endian only
   
-#define htonl(A)    ((((unsigned long)(A) & 0xff000000) >> 24) | \
-                     (((unsigned long)(A) & 0x00ff0000) >> 8) | \
-                     (((unsigned long)(A) & 0x0000ff00) << 8) | \
-                     (((unsigned long)(A) & 0x000000ff) << 24))
+#define htonl(A)    ((((UINT32)(A) & 0xff000000) >> 24) | \
+                     (((UINT32)(A) & 0x00ff0000) >> 8) | \
+                     (((UINT32)(A) & 0x0000ff00) << 8) | \
+                     (((UINT32)(A) & 0x000000ff) << 24))
 
 #define ntohl                   htonl
 
 //Use in case of Big Endian only
-#define htons(A)     ((((unsigned long)(A) & 0xff00) >> 8) | \
-                      (((unsigned long)(A) & 0x00ff) << 8))
+#define htons(A)     ((((UINT32)(A) & 0xff00) >> 8) | \
+                      (((UINT32)(A) & 0x00ff) << 8))
 
 
 #define ntohs                   htons
@@ -245,7 +216,7 @@ typedef struct
 //!          application layer to obtain a socket handle.
 //
 //*****************************************************************************
-extern int socket(long domain, long type, long protocol);
+extern INT16 CC3000_EXPORT(socket)(INT32 domain, INT32 type, INT32 protocol);
 
 //*****************************************************************************
 //
@@ -258,7 +229,7 @@ extern int socket(long domain, long type, long protocol);
 //!  @brief  The socket function closes a created socket.
 //
 //*****************************************************************************
-extern long closesocket(long sd);
+extern INT32 CC3000_EXPORT(closesocket)(INT32 sd);
 
 //*****************************************************************************
 //
@@ -304,7 +275,7 @@ extern long closesocket(long sd);
 //! @sa     socket ; bind ; listen
 //
 //*****************************************************************************
-extern long accept(long sd, sockaddr *addr, socklen_t *addrlen);
+extern INT32 CC3000_EXPORT(accept)(INT32 sd, sockaddr *addr, socklen_t *addrlen);
 
 //*****************************************************************************
 //
@@ -328,7 +299,7 @@ extern long accept(long sd, sockaddr *addr, socklen_t *addrlen);
 //! @sa     socket ; accept ; listen
 //
 //*****************************************************************************
-extern long bind(long sd, const sockaddr *addr, long addrlen);
+extern INT32 CC3000_EXPORT(bind)(INT32 sd, const sockaddr *addr, INT32 addrlen);
 
 //*****************************************************************************
 //
@@ -352,7 +323,7 @@ extern long bind(long sd, const sockaddr *addr, long addrlen);
 //! @note   On this version, backlog is not supported
 //
 //*****************************************************************************
-extern long listen(long sd, long backlog);
+extern INT32 CC3000_EXPORT(listen)(INT32 sd, INT32 backlog);
 
 //*****************************************************************************
 //
@@ -373,7 +344,7 @@ extern long listen(long sd, long backlog);
 //
 //*****************************************************************************
 #ifndef CC3000_TINY_DRIVER 
-extern int gethostbyname(const char * hostname, uint8_t usNameLen, uint32_t* out_ip_addr);
+extern INT16 CC3000_EXPORT(gethostbyname)(CHAR * hostname, UINT16 usNameLen, UINT32* out_ip_addr);
 #endif
 
 
@@ -405,7 +376,7 @@ extern int gethostbyname(const char * hostname, uint8_t usNameLen, uint32_t* out
 //!  @sa socket
 //
 //*****************************************************************************
-extern long connect(long sd, const sockaddr *addr, long addrlen);
+extern INT32 CC3000_EXPORT(connect)(INT32 sd, const sockaddr *addr, INT32 addrlen);
 
 //*****************************************************************************
 //
@@ -444,7 +415,7 @@ extern long connect(long sd, const sockaddr *addr, long addrlen);
 //!  @sa socket
 //
 //*****************************************************************************
-extern int select(long nfds, fd_set *readsds, fd_set *writesds,
+extern INT16 CC3000_EXPORT(select)(INT32 nfds, fd_set *readsds, fd_set *writesds,
                   fd_set *exceptsds, struct timeval *timeout);
 
 //*****************************************************************************
@@ -485,7 +456,7 @@ extern int select(long nfds, fd_set *readsds, fd_set *writesds,
 //!		       1. SOCKOPT_RECV_TIMEOUT (optname)
 //!			      SOCKOPT_RECV_TIMEOUT configures recv and recvfrom timeout 
 //!           in milliseconds.
-//!		        In that case optval should be pointer to unsigned long.
+//!		        In that case optval should be pointer to UINT32.
 //!		       2. SOCKOPT_NONBLOCK (optname). sets the socket non-blocking mode on 
 //!           or off.
 //!		        In that case optval should be SOCK_ON or SOCK_OFF (optval).
@@ -494,7 +465,7 @@ extern int select(long nfds, fd_set *readsds, fd_set *writesds,
 //
 //*****************************************************************************
 #ifndef CC3000_TINY_DRIVER 
-extern int setsockopt(long sd, long level, long optname, const void *optval,
+extern INT16 CC3000_EXPORT(setsockopt)(INT32 sd, INT32 level, INT32 optname, const void *optval,
                       socklen_t optlen);
 #endif
 //*****************************************************************************
@@ -535,7 +506,7 @@ extern int setsockopt(long sd, long level, long optname, const void *optval,
 //!		       1. SOCKOPT_RECV_TIMEOUT (optname)
 //!			      SOCKOPT_RECV_TIMEOUT configures recv and recvfrom timeout 
 //!           in milliseconds.
-//!		        In that case optval should be pointer to unsigned long.
+//!		        In that case optval should be pointer to UINT32.
 //!		       2. SOCKOPT_NONBLOCK (optname). sets the socket non-blocking mode on 
 //!           or off.
 //!		        In that case optval should be SOCK_ON or SOCK_OFF (optval).
@@ -543,7 +514,7 @@ extern int setsockopt(long sd, long level, long optname, const void *optval,
 //!  @sa setsockopt
 //
 //*****************************************************************************
-extern int getsockopt(long sd, long level, long optname, void *optval,
+extern INT16 CC3000_EXPORT(getsockopt)(INT32 sd, INT32 level, INT32 optname, void *optval,
                       socklen_t *optlen);
 
 //*****************************************************************************
@@ -567,7 +538,7 @@ extern int getsockopt(long sd, long level, long optname, void *optval,
 //!  @Note On this version, only blocking mode is supported.
 //
 //*****************************************************************************
-extern int recv(long sd, void *buf, long len, long flags);
+extern INT16 CC3000_EXPORT(recv)(INT32 sd, void *buf, INT32 len, INT32 flags);
 
 //*****************************************************************************
 //
@@ -597,7 +568,7 @@ extern int recv(long sd, void *buf, long len, long flags);
 //!  @Note On this version, only blocking mode is supported.
 //
 //*****************************************************************************
-extern int recvfrom(long sd, void *buf, long len, long flags, sockaddr *from, 
+extern INT16 CC3000_EXPORT(recvfrom)(INT32 sd, void *buf, INT32 len, INT32 flags, sockaddr *from, 
                     socklen_t *fromlen);
 
 //*****************************************************************************
@@ -622,7 +593,7 @@ extern int recvfrom(long sd, void *buf, long len, long flags, sockaddr *from,
 //
 //*****************************************************************************
 
-extern int send(long sd, const void *buf, long len, long flags);
+extern INT16 CC3000_EXPORT(send)(INT32 sd, const void *buf, INT32 len, INT32 flags);
 
 //*****************************************************************************
 //
@@ -650,7 +621,7 @@ extern int send(long sd, const void *buf, long len, long flags);
 //
 //*****************************************************************************
 
-extern int sendto(long sd, const void *buf, long len, long flags, 
+extern INT16 CC3000_EXPORT(sendto)(INT32 sd, const void *buf, INT32 len, INT32 flags, 
                   const sockaddr *to, socklen_t tolen);
 
 //*****************************************************************************
@@ -660,7 +631,7 @@ extern int sendto(long sd, const void *buf, long len, long flags,
 //!  @param[in] mdnsEnabled         flag to enable/disable the mDNS feature
 //!  @param[in] deviceServiceName   Service name as part of the published
 //!                                 canonical domain name
-//!  @param[in] deviceServiceNameLength   Length of the service name
+//!  @param[in] deviceServiceNameLength   Length of the service name - up to 32 chars
 //!  
 //!
 //!  @return   On success, zero is returned, return SOC_ERROR if socket was not 
@@ -669,7 +640,21 @@ extern int sendto(long sd, const void *buf, long len, long flags,
 //!  @brief    Set CC3000 in mDNS advertiser mode in order to advertise itself.
 //
 //*****************************************************************************
-extern int mdnsAdvertiser(unsigned short mdnsEnabled, char * deviceServiceName, unsigned short deviceServiceNameLength);
+extern INT16 CC3000_EXPORT(mdnsAdvertiser)(UINT16 mdnsEnabled, CHAR * deviceServiceName, UINT16 deviceServiceNameLength);
+
+
+//*****************************************************************************
+//
+//!  getmssvalue
+//!
+//!  @param[in] sd         socket descriptor
+//!
+//!  @return   On success, returns the MSS value of a TCP connection
+//!
+//!  @brief    Returns the MSS value of a TCP connection according to the socket descriptor
+//
+//*****************************************************************************
+extern UINT16 CC3000_EXPORT(getmssvalue) (INT32 sd);
 
 //*****************************************************************************
 //

drivers/cc3000/inc/wlan.h

@@ -3,14 +3,6 @@
 *  wlan.h  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -39,17 +31,9 @@
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
-
-Adapted for use with the Arduino/AVR by KTOWN for Adafruit Industries
-This library works with the Adafruit CC3000 breakout 
-	----> https://www.adafruit.com/products/1469
-Adafruit invests time and resources providing this open source code,
-please support Adafruit and open-source hardware by purchasing
-products from Adafruit!
-
 *****************************************************************************/
-#ifndef __WLAN_H__
-#define	__WLAN_H__
+#ifndef __CC3000_WLAN_H__
+#define	__CC3000_WLAN_H__
 
 #include "cc3000_common.h"
 
@@ -157,7 +141,7 @@ extern void wlan_init(		tWlanCB	 	sWlanCB,
 //!
 //
 //*****************************************************************************
-extern void wlan_start(unsigned short usPatchesAvailableAtHost);
+extern int wlan_start(UINT16 usPatchesAvailableAtHost);
 
 //*****************************************************************************
 //
@@ -185,7 +169,7 @@ extern void wlan_stop(void);
 //!  @param    ssid       up to 32 bytes and is ASCII SSID of the AP
 //!  @param    ssid_len   length of the SSID
 //!  @param    bssid      6 bytes specified the AP bssid
-//!  @param    key        up to 16 bytes specified the AP security key
+//!  @param    key        up to 32 bytes specified the AP security key
 //!  @param    key_len    key length 
 //!
 //!  @return     On success, zero is returned. On error, negative is returned. 
@@ -205,10 +189,10 @@ extern void wlan_stop(void);
 //
 //*****************************************************************************
 #ifndef CC3000_TINY_DRIVER
-extern long wlan_connect(unsigned long ulSecType, const char *ssid, long ssid_len,
-                        unsigned char *bssid, unsigned char *key, long key_len);
+extern INT32 wlan_connect(UINT32 ulSecType, CHAR *ssid, INT32 ssid_len,
+                        UINT8 *bssid, UINT8 *key, INT32 key_len);
 #else
-extern long wlan_connect(const char *ssid, long ssid_len);
+extern INT32 wlan_connect(CHAR *ssid, INT32 ssid_len);
 
 #endif
 
@@ -224,7 +208,7 @@ extern long wlan_connect(const char *ssid, long ssid_len);
 //
 //*****************************************************************************
 
-extern long wlan_disconnect(void);
+extern INT32 wlan_disconnect(void);
 
 //*****************************************************************************
 //
@@ -241,7 +225,8 @@ extern long wlan_disconnect(void);
 //!  @param    ucPf_OrKey       security key
 //!  @param    ulPassPhraseLen  security key length for WPA\WPA2
 //!
-//!  @return    On success, zero is returned. On error, -1 is returned        
+//!  @return    On success, index (1-7) of the stored profile is returned.         
+//!				On error, -1 is returned.        
 //!
 //!  @brief     When auto start is enabled, the device connects to
 //!             station from the profiles table. Up to 7 profiles are supported. 
@@ -254,15 +239,15 @@ extern long wlan_disconnect(void);
 //
 //*****************************************************************************
 
-extern long wlan_add_profile(unsigned long ulSecType, unsigned char* ucSsid,
-										 unsigned long ulSsidLen, 
-										 unsigned char *ucBssid,
-                                         unsigned long ulPriority,
-                                         unsigned long ulPairwiseCipher_Or_Key,
-                                         unsigned long ulGroupCipher_TxKeyLen,
-                                         unsigned long ulKeyMgmt,
-                                         unsigned char* ucPf_OrKey,
-                                         unsigned long ulPassPhraseLen);
+extern INT32 wlan_add_profile(UINT32 ulSecType, UINT8* ucSsid,
+										 UINT32 ulSsidLen, 
+										 UINT8 *ucBssid,
+                                         UINT32 ulPriority,
+                                         UINT32 ulPairwiseCipher_Or_Key,
+                                         UINT32 ulGroupCipher_TxKeyLen,
+                                         UINT32 ulKeyMgmt,
+                                         UINT8* ucPf_OrKey,
+                                         UINT32 ulPassPhraseLen);
 
 
 
@@ -281,7 +266,7 @@ extern long wlan_add_profile(unsigned long ulSecType, unsigned char* ucSsid,
 //!  @sa        wlan_add_profile 
 //
 //*****************************************************************************
-extern long wlan_ioctl_del_profile(unsigned long ulIndex);
+extern INT32 wlan_ioctl_del_profile(UINT32 ulIndex);
 
 //*****************************************************************************
 //
@@ -304,7 +289,7 @@ extern long wlan_ioctl_del_profile(unsigned long ulIndex);
 //!            masked (1), the device will not send the masked event to host. 
 //
 //*****************************************************************************
-extern long wlan_set_event_mask(unsigned long ulMask);
+extern INT32 wlan_set_event_mask(UINT32 ulMask);
 
 //*****************************************************************************
 //
@@ -318,7 +303,7 @@ extern long wlan_set_event_mask(unsigned long ulMask);
 //!  @brief    get wlan status: disconnected, scanning, connecting or connected
 //
 //*****************************************************************************
-extern long wlan_ioctl_statusget(void);
+extern INT32 wlan_ioctl_statusget(void);
 
 
 //*****************************************************************************
@@ -352,10 +337,10 @@ extern long wlan_ioctl_statusget(void);
 //!  @sa         wlan_add_profile , wlan_ioctl_del_profile 
 //
 //*****************************************************************************
-extern long wlan_ioctl_set_connection_policy(
-                                        unsigned long should_connect_to_open_ap,
-                                        unsigned long should_use_fast_connect,
-                                        unsigned long ulUseProfiles);
+extern INT32 wlan_ioctl_set_connection_policy(
+                                        UINT32 should_connect_to_open_ap,
+                                        UINT32 should_use_fast_connect,
+                                        UINT32 ulUseProfiles);
 
 //*****************************************************************************
 //
@@ -392,8 +377,8 @@ extern long wlan_ioctl_set_connection_policy(
 //*****************************************************************************
 
 
-extern long wlan_ioctl_get_scan_results(unsigned long ulScanTimeout,
-                                       unsigned char *ucResults);
+extern INT32 wlan_ioctl_get_scan_results(UINT32 ulScanTimeout,
+                                       UINT8 *ucResults);
 
 //*****************************************************************************
 //
@@ -419,7 +404,7 @@ extern long wlan_ioctl_get_scan_results(unsigned long ulScanTimeout,
 //!  @param   uiSNRThreshold    NSR threshold. Saved: yes (Default: 0)
 //!  @param   uiDefaultTxPower  probe Tx power. Saved: yes (Default: 205)
 //!  @param   aiIntervalList    pointer to array with 16 entries (16 channels) 
-//!           each entry (unsigned long) holds timeout between periodic scan 
+//!           each entry (UINT32) holds timeout between periodic scan 
 //!           (connection scan) - in milliseconds. Saved: yes. Default 2000ms.
 //!
 //!  @return    On success, zero is returned. On error, -1 is returned        
@@ -431,13 +416,13 @@ extern long wlan_ioctl_get_scan_results(unsigned long ulScanTimeout,
 //!  @sa        wlan_ioctl_get_scan_results 
 //
 //*****************************************************************************
-extern long wlan_ioctl_set_scan_params(unsigned long uiEnable, unsigned long 
-											 uiMinDwellTime,unsigned long uiMaxDwellTime,
-										   unsigned long uiNumOfProbeRequests,
-											 unsigned long uiChannelMask,
-										   long iRSSIThreshold,unsigned long uiSNRThreshold,
-										   unsigned long uiDefaultTxPower, 
-											 unsigned long *aiIntervalList);
+extern INT32 wlan_ioctl_set_scan_params(UINT32 uiEnable, UINT32 
+											 uiMinDwellTime,UINT32 uiMaxDwellTime,
+										   UINT32 uiNumOfProbeRequests,
+											 UINT32 uiChannelMask,
+										   INT32 iRSSIThreshold,UINT32 uiSNRThreshold,
+										   UINT32 uiDefaultTxPower, 
+											 UINT32 *aiIntervalList);
 
                                            
 //*****************************************************************************
@@ -460,7 +445,7 @@ extern long wlan_ioctl_set_scan_params(unsigned long uiEnable, unsigned long
 //!  @sa      wlan_smart_config_set_prefix , wlan_smart_config_stop
 //
 //*****************************************************************************                                        
-extern long wlan_smart_config_start(unsigned long algoEncryptedFlag);
+extern INT32 wlan_smart_config_start(UINT32 algoEncryptedFlag);
 
 
 //*****************************************************************************
@@ -476,7 +461,7 @@ extern long wlan_smart_config_start(unsigned long algoEncryptedFlag);
 //!  @sa      wlan_smart_config_start , wlan_smart_config_set_prefix
 //
 //*****************************************************************************
-extern long wlan_smart_config_stop(void);
+extern INT32 wlan_smart_config_stop(void);
 
 //*****************************************************************************
 //
@@ -494,7 +479,7 @@ extern long wlan_smart_config_stop(void);
 //!  @sa      wlan_smart_config_start , wlan_smart_config_stop
 //
 //*****************************************************************************
-extern long wlan_smart_config_set_prefix(char* cNewPrefix);
+extern INT32 wlan_smart_config_set_prefix(CHAR* cNewPrefix);
 
 //*****************************************************************************
 //
@@ -510,7 +495,7 @@ extern long wlan_smart_config_set_prefix(char* cNewPrefix);
 //!           behavior is as defined by connection policy.
 //
 //*****************************************************************************
-extern long wlan_smart_config_process(void);
+extern INT32 wlan_smart_config_process(void);
 
 //*****************************************************************************
 //
@@ -530,4 +515,4 @@ extern long wlan_smart_config_process(void);
 }
 #endif // __cplusplus
 
-#endif	// __WLAN_H__
+#endif	// __CC3000_WLAN_H__

drivers/cc3000/src/cc3000_common.c

@@ -3,14 +3,6 @@
 *  cc3000_common.c.c  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -47,17 +39,15 @@
 //
 //*****************************************************************************
 /******************************************************************************
- *
- * Include files
- *
- *****************************************************************************/
-#include <stdint.h>
+*
+* Include files
+*
+*****************************************************************************/
 
 #include "cc3000_common.h"
 #include "socket.h"
 #include "wlan.h"
 #include "evnt_handler.h"
-#include "ccdebug.h"
 
 //*****************************************************************************
 //
@@ -71,10 +61,9 @@
 //!  @brief stub function for ASSERT macro
 //
 //*****************************************************************************
-void
-__error__(char *pcFilename, unsigned long ulLine)
+void __error__(CHAR *pcFilename, UINT32 ulLine)
 {
-    //TODO full up function
+	//TODO full up function
 }
 
 
@@ -93,12 +82,12 @@ __error__(char *pcFilename, unsigned long ulLine)
 //
 //*****************************************************************************
 
-uint8_t* UINT32_TO_STREAM_f (uint8_t *p, uint32_t u32)
+UINT8* UINT32_TO_STREAM_f (UINT8 *p, UINT32 u32)
 {
-	*(p)++ = (uint8_t)(u32);
-	*(p)++ = (uint8_t)((u32) >> 8);
-	*(p)++ = (uint8_t)((u32) >> 16);
-	*(p)++ = (uint8_t)((u32) >> 24);
+	*(p)++ = (UINT8)(u32);
+	*(p)++ = (UINT8)((u32) >> 8);
+	*(p)++ = (UINT8)((u32) >> 16);
+	*(p)++ = (UINT8)((u32) >> 24);
 	return p;
 }
 
@@ -116,10 +105,10 @@ uint8_t* UINT32_TO_STREAM_f (uint8_t *p, uint32_t u32)
 //
 //*****************************************************************************
 
-uint8_t* UINT16_TO_STREAM_f (uint8_t *p, uint16_t u16)
+UINT8* UINT16_TO_STREAM_f (UINT8 *p, UINT16 u16)
 {
-	*(p)++ = (uint8_t)(u16);
-	*(p)++ = (uint8_t)((u16) >> 8);
+	*(p)++ = (UINT8)(u16);
+	*(p)++ = (UINT8)((u16) >> 8);
 	return p;
 }
 
@@ -137,20 +126,10 @@ uint8_t* UINT16_TO_STREAM_f (uint8_t *p, uint16_t u16)
 //
 //*****************************************************************************
 
-uint16_t STREAM_TO_UINT16_f(char* cp, uint16_t offset)
+UINT16 STREAM_TO_UINT16_f(CHAR* p, UINT16 offset)
 {
-  uint8_t *p = (uint8_t *)cp;
-  /*
-  DEBUGPRINT_F("Stream2u16: ");
-  DEBUGPRINT_HEX(cp[offset+1]);
-  DEBUGPRINT_F(" + ");
-  DEBUGPRINT_HEX(cp[offset]);
-  DEBUGPRINT_F("\n\r");
-  */
-
-  return (uint16_t)((uint16_t)
-		    ((uint16_t)(*(p + offset + 1)) << 8) +
-		    (uint16_t)(*(p + offset)));
+	return (UINT16)((UINT16)((UINT16)
+		(*(p + offset + 1)) << 8) + (UINT16)(*(p + offset)));
 }
 
 //*****************************************************************************
@@ -167,23 +146,12 @@ uint16_t STREAM_TO_UINT16_f(char* cp, uint16_t offset)
 //
 //*****************************************************************************
 
-uint32_t STREAM_TO_UINT32_f(char * cp, uint16_t offset)
+UINT32 STREAM_TO_UINT32_f(CHAR* p, UINT16 offset)
 {
-  uint8_t *p = (uint8_t *)cp;
-  
-  /*
-  DEBUGPRINT_F("\tStream2u32: ");
-  DEBUGPRINT_HEX(cp[offset+3]);  DEBUGPRINT_F(" + ");
-  DEBUGPRINT_HEX(cp[offset+2]);  DEBUGPRINT_F(" + ");
-  DEBUGPRINT_HEX(cp[offset+1]);  DEBUGPRINT_F(" + ");
-  DEBUGPRINT_HEX(cp[offset]);
-  DEBUGPRINT_F("\n\r");
-  */
-
-  return (uint32_t)((uint32_t)((uint32_t)
-	(*(p + offset + 3)) << 24) + (uint32_t)((uint32_t)
-	(*(p + offset + 2)) << 16) + (uint32_t)((uint32_t)
-	(*(p + offset + 1)) << 8) + (uint32_t)(*(p + offset)));
+	return (UINT32)((UINT32)((UINT32)
+		(*(p + offset + 3)) << 24) + (UINT32)((UINT32)
+		(*(p + offset + 2)) << 16) + (UINT32)((UINT32)
+		(*(p + offset + 1)) << 8) + (UINT32)(*(p + offset)));
 }
 
 

drivers/cc3000/src/ccspi.c

@@ -0,0 +1,456 @@
+/*****************************************************************************
+ *
+ *  spi.c - CC3000 Host Driver Implementation.
+ *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
+ *
+ *  Redistribution and use in source and binary forms, with or without
+ *  modification, are permitted provided that the following conditions
+ *  are met:
+ *
+ *    Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ *
+ *    Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ *    Neither the name of Texas Instruments Incorporated nor the names of
+ *    its contributors may be used to endorse or promote products derived
+ *    from this software without specific prior written permission.
+ *
+ *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *****************************************************************************/
+
+#include <string.h>
+
+#include "py/nlr.h"
+#include "py/obj.h"
+#include "py/runtime.h"
+#include "pin.h"
+#include "led.h"
+#include "extint.h"
+#include "spi.h"
+#include "ccspi.h"
+#include "evnt_handler.h"
+
+#if 0 // print debugging info
+#include <stdio.h>
+#define DEBUG_printf(args...) printf(args)
+#else // don't print debugging info
+#define DEBUG_printf(args...) (void)0
+#endif
+
+// these need to be set to valid values before anything in this file will work
+STATIC SPI_HandleTypeDef *SPI_HANDLE = NULL;
+STATIC const pin_obj_t *PIN_CS = NULL;
+STATIC const pin_obj_t *PIN_EN = NULL;
+STATIC const pin_obj_t *PIN_IRQ = NULL;
+
+#define CS_LOW()            HAL_GPIO_WritePin(PIN_CS->gpio, PIN_CS->pin_mask, GPIO_PIN_RESET)
+#define CS_HIGH()           HAL_GPIO_WritePin(PIN_CS->gpio, PIN_CS->pin_mask, GPIO_PIN_SET)
+
+#define READ                3
+#define WRITE               1
+
+#define HI(value)           (((value) & 0xFF00) >> 8)
+#define LO(value)           ((value) & 0x00FF)
+
+#define SPI_TIMEOUT         (1000)
+#define HEADERS_SIZE_EVNT   (SPI_HEADER_SIZE + 5)
+
+/* SPI bus states */
+#define eSPI_STATE_POWERUP                  (0)
+#define eSPI_STATE_INITIALIZED              (1)
+#define eSPI_STATE_IDLE                     (2)
+#define eSPI_STATE_WRITE_IRQ                (3)
+#define eSPI_STATE_WRITE_FIRST_PORTION      (4)
+#define eSPI_STATE_WRITE_EOT                (5)
+#define eSPI_STATE_READ_IRQ                 (6)
+#define eSPI_STATE_READ_FIRST_PORTION       (7)
+#define eSPI_STATE_READ_EOT                 (8)
+
+// The magic number that resides at the end of the TX/RX buffer (1 byte after the allocated size)
+// for the purpose of detection of the overrun. The location of the memory where the magic number
+// resides shall never be written. In case it is written - the overrun occured and either recevie function
+// or send function will stuck forever.
+#define CC3000_BUFFER_MAGIC_NUMBER (0xDE)
+
+typedef struct {
+    gcSpiHandleRx  SPIRxHandler;
+    unsigned short usTxPacketLength;
+    unsigned short usRxPacketLength;
+    unsigned long  ulSpiState;
+    unsigned char *pTxPacket;
+    unsigned char *pRxPacket;
+} tSpiInformation;
+STATIC tSpiInformation sSpiInformation;
+
+STATIC char spi_buffer[CC3000_RX_BUFFER_SIZE];
+unsigned char wlan_tx_buffer[CC3000_TX_BUFFER_SIZE];
+
+STATIC const mp_obj_fun_builtin_t irq_callback_obj;
+
+// set the pins to use to communicate with the CC3000
+// the arguments must be of type pin_obj_t* and SPI_HandleTypeDef*
+void SpiInit(void *spi, const void *pin_cs, const void *pin_en, const void *pin_irq) {
+    SPI_HANDLE = spi;
+    PIN_CS = pin_cs;
+    PIN_EN = pin_en;
+    PIN_IRQ = pin_irq;
+}
+
+void SpiClose(void)
+{
+    if (sSpiInformation.pRxPacket) {
+        sSpiInformation.pRxPacket = 0;
+    }
+
+    tSLInformation.WlanInterruptDisable();
+
+    //HAL_SPI_DeInit(SPI_HANDLE);
+}
+
+void SpiOpen(gcSpiHandleRx pfRxHandler)
+{
+    DEBUG_printf("SpiOpen\n");
+
+    /* initialize SPI state */
+    sSpiInformation.ulSpiState = eSPI_STATE_POWERUP;
+    sSpiInformation.SPIRxHandler = pfRxHandler;
+    sSpiInformation.usTxPacketLength = 0;
+    sSpiInformation.pTxPacket = NULL;
+    sSpiInformation.pRxPacket = (unsigned char *)spi_buffer;
+    sSpiInformation.usRxPacketLength = 0;
+    spi_buffer[CC3000_RX_BUFFER_SIZE - 1] = CC3000_BUFFER_MAGIC_NUMBER;
+    wlan_tx_buffer[CC3000_TX_BUFFER_SIZE - 1] = CC3000_BUFFER_MAGIC_NUMBER;
+
+    /* SPI configuration */
+    SPI_HANDLE->Init.Mode              = SPI_MODE_MASTER;
+    SPI_HANDLE->Init.Direction         = SPI_DIRECTION_2LINES;
+    SPI_HANDLE->Init.DataSize          = SPI_DATASIZE_8BIT;
+    SPI_HANDLE->Init.CLKPolarity       = SPI_POLARITY_LOW;
+    SPI_HANDLE->Init.CLKPhase          = SPI_PHASE_2EDGE;
+    SPI_HANDLE->Init.NSS               = SPI_NSS_SOFT;
+    SPI_HANDLE->Init.BaudRatePrescaler = SPI_BAUDRATEPRESCALER_8;
+    SPI_HANDLE->Init.FirstBit          = SPI_FIRSTBIT_MSB;
+    SPI_HANDLE->Init.TIMode            = SPI_TIMODE_DISABLED;
+    SPI_HANDLE->Init.CRCCalculation    = SPI_CRCCALCULATION_DISABLED;
+    SPI_HANDLE->Init.CRCPolynomial     = 7;
+    spi_init(SPI_HANDLE, false);
+
+    // configure wlan CS and EN pins
+    GPIO_InitTypeDef GPIO_InitStructure;
+    GPIO_InitStructure.Speed = GPIO_SPEED_FAST;
+    GPIO_InitStructure.Mode = GPIO_MODE_OUTPUT_PP;
+    GPIO_InitStructure.Pull = GPIO_NOPULL;
+    GPIO_InitStructure.Alternate = 0;
+
+    GPIO_InitStructure.Pin = PIN_CS->pin_mask;
+    HAL_GPIO_Init(PIN_CS->gpio, &GPIO_InitStructure);
+
+    GPIO_InitStructure.Pin = PIN_EN->pin_mask;
+    HAL_GPIO_Init(PIN_EN->gpio, &GPIO_InitStructure);
+
+    HAL_GPIO_WritePin(PIN_CS->gpio, PIN_CS->pin_mask, GPIO_PIN_SET);
+    HAL_GPIO_WritePin(PIN_EN->gpio, PIN_EN->pin_mask, GPIO_PIN_RESET);
+
+    /* do a dummy read, this ensures SCLK is low before
+       actual communications start, it might be required */
+    CS_LOW();
+    uint8_t buf[1];
+    HAL_SPI_Receive(SPI_HANDLE, buf, sizeof(buf), SPI_TIMEOUT);
+    CS_HIGH();
+
+    // register EXTI
+    extint_register((mp_obj_t)PIN_IRQ, GPIO_MODE_IT_FALLING, GPIO_PULLUP, (mp_obj_t)&irq_callback_obj, true);
+    extint_enable(PIN_IRQ->pin);
+
+    DEBUG_printf("SpiOpen finished; IRQ.pin=%d IRQ_LINE=%d\n", PIN_IRQ->pin, PIN_IRQ->pin);
+}
+
+long ReadWlanInterruptPin(void)
+{
+    return HAL_GPIO_ReadPin(PIN_IRQ->gpio, PIN_IRQ->pin_mask);
+}
+
+void WriteWlanPin(unsigned char val)
+{
+    HAL_GPIO_WritePin(PIN_EN->gpio, PIN_EN->pin_mask,
+            (WLAN_ENABLE)? GPIO_PIN_SET:GPIO_PIN_RESET);
+}
+
+STATIC void SpiWriteDataSynchronous(unsigned char *data, unsigned short size)
+{
+    DEBUG_printf("SpiWriteDataSynchronous(data=%p [%x %x %x %x], size=%u)\n", data, data[0], data[1], data[2], data[3], size);
+    __disable_irq();
+    if (HAL_SPI_TransmitReceive(SPI_HANDLE, data, data, size, SPI_TIMEOUT) != HAL_OK) {
+        //BREAK();
+    }
+    __enable_irq();
+    DEBUG_printf(" - rx data = [%x %x %x %x]\n", data[0], data[1], data[2], data[3]);
+}
+
+STATIC void SpiReadDataSynchronous(unsigned char *data, unsigned short size)
+{
+    memset(data, READ, size);
+    __disable_irq();
+    if (HAL_SPI_TransmitReceive(SPI_HANDLE, data, data, size, SPI_TIMEOUT) != HAL_OK) {
+       //BREAK();
+    }
+    __enable_irq();
+}
+
+STATIC void __delay_cycles(volatile int x)
+{
+    x *= 6; // for 168 MHz CPU
+    while (x--);
+}
+
+STATIC long SpiFirstWrite(unsigned char *ucBuf, unsigned short usLength)
+{
+    DEBUG_printf("SpiFirstWrite %lu\n", sSpiInformation.ulSpiState);
+
+    CS_LOW();
+
+    // Assuming we are running on 24 MHz ~50 micro delay is 1200 cycles;
+    __delay_cycles(1200);
+
+    // SPI writes first 4 bytes of data
+    SpiWriteDataSynchronous(ucBuf, 4);
+
+    __delay_cycles(1200);
+
+    SpiWriteDataSynchronous(ucBuf + 4, usLength - 4);
+
+    // From this point on - operate in a regular way
+    sSpiInformation.ulSpiState = eSPI_STATE_IDLE;
+
+    CS_HIGH();
+
+    return(0);
+}
+
+long SpiWrite(unsigned char *pUserBuffer, unsigned short usLength)
+{
+    DEBUG_printf("SpiWrite %lu\n", sSpiInformation.ulSpiState);
+
+    unsigned char ucPad = 0;
+
+    // Figure out the total length of the packet in order to figure out if there 
+    // is padding or not
+    if(!(usLength & 0x0001)) {
+        ucPad++;
+    }
+
+    pUserBuffer[0] = WRITE;
+    pUserBuffer[1] = HI(usLength + ucPad);
+    pUserBuffer[2] = LO(usLength + ucPad);
+    pUserBuffer[3] = 0;
+    pUserBuffer[4] = 0;
+
+    usLength += (SPI_HEADER_SIZE + ucPad);
+
+    // The magic number that resides at the end of the TX/RX buffer (1 byte after the allocated size)
+    // for the purpose of detection of the overrun. If the magic number is overriten - buffer overrun
+    // occurred - and we will stuck here forever!
+    if (wlan_tx_buffer[CC3000_TX_BUFFER_SIZE - 1] != CC3000_BUFFER_MAGIC_NUMBER) {
+        while (1);
+    }
+
+    if (sSpiInformation.ulSpiState == eSPI_STATE_POWERUP) {
+        while (sSpiInformation.ulSpiState != eSPI_STATE_INITIALIZED);
+    }
+
+    if (sSpiInformation.ulSpiState == eSPI_STATE_INITIALIZED) {
+        // This is time for first TX/RX transactions over SPI:
+        // the IRQ is down - so need to send read buffer size command
+        SpiFirstWrite(pUserBuffer, usLength);
+    } else {
+        //
+        // We need to prevent here race that can occur in case 2 back to back packets are sent to the
+        // device, so the state will move to IDLE and once again to not IDLE due to IRQ
+        //
+        tSLInformation.WlanInterruptDisable();
+
+        while (sSpiInformation.ulSpiState != eSPI_STATE_IDLE);
+
+        sSpiInformation.ulSpiState = eSPI_STATE_WRITE_IRQ;
+        sSpiInformation.pTxPacket = pUserBuffer;
+        sSpiInformation.usTxPacketLength = usLength;
+
+        // Assert the CS line and wait till SSI IRQ line is active and then initialize write operation
+        CS_LOW();
+
+        // Re-enable IRQ - if it was not disabled - this is not a problem...
+        tSLInformation.WlanInterruptEnable();
+
+        // check for a missing interrupt between the CS assertion and enabling back the interrupts
+        if (tSLInformation.ReadWlanInterruptPin() == 0) {
+            SpiWriteDataSynchronous(sSpiInformation.pTxPacket, sSpiInformation.usTxPacketLength);
+
+            sSpiInformation.ulSpiState = eSPI_STATE_IDLE;
+
+            CS_HIGH();
+        }
+    }
+
+    // Due to the fact that we are currently implementing a blocking situation
+    // here we will wait till end of transaction
+    while (eSPI_STATE_IDLE != sSpiInformation.ulSpiState);
+
+    return(0);
+}
+
+#if 0
+unused
+STATIC void SpiReadPacket(void)
+{
+    int length;
+
+    /* read SPI header */
+    SpiReadDataSynchronous(sSpiInformation.pRxPacket, SPI_HEADER_SIZE);
+
+    /* parse data length  */
+    STREAM_TO_UINT8(sSpiInformation.pRxPacket, SPI_HEADER_SIZE-1, length);
+
+    /* read the remainder of the packet */
+    SpiReadDataSynchronous(sSpiInformation.pRxPacket + SPI_HEADER_SIZE, length);
+
+    sSpiInformation.ulSpiState = eSPI_STATE_READ_EOT;
+}
+#endif
+
+STATIC void SpiReadHeader(void)
+{
+    SpiReadDataSynchronous(sSpiInformation.pRxPacket, 10);
+}
+
+STATIC void SpiTriggerRxProcessing(void)
+{
+    SpiPauseSpi();
+    CS_HIGH();
+
+    // The magic number that resides at the end of the TX/RX buffer (1 byte after the allocated size)
+    // for the purpose of detection of the overrun. If the magic number is overriten - buffer overrun
+    // occurred - and we will stuck here forever!
+    if (sSpiInformation.pRxPacket[CC3000_RX_BUFFER_SIZE - 1] != CC3000_BUFFER_MAGIC_NUMBER) {
+        while (1);
+    }
+
+    sSpiInformation.ulSpiState = eSPI_STATE_IDLE;
+    sSpiInformation.SPIRxHandler(sSpiInformation.pRxPacket + SPI_HEADER_SIZE);
+}
+
+
+STATIC long SpiReadDataCont(void)
+{
+    long data_to_recv=0;
+    unsigned char *evnt_buff, type;
+
+    //determine what type of packet we have
+    evnt_buff =  sSpiInformation.pRxPacket;
+    STREAM_TO_UINT8((char *)(evnt_buff + SPI_HEADER_SIZE), HCI_PACKET_TYPE_OFFSET, type);
+
+    switch (type) {
+        case HCI_TYPE_DATA:{
+                // We need to read the rest of data..
+                STREAM_TO_UINT16((char *)(evnt_buff + SPI_HEADER_SIZE),
+                        HCI_DATA_LENGTH_OFFSET, data_to_recv);
+                if (!((HEADERS_SIZE_EVNT + data_to_recv) & 1)) {
+                    data_to_recv++;
+                }
+
+                if (data_to_recv) {
+                    SpiReadDataSynchronous(evnt_buff + 10, data_to_recv);
+                }
+                break;
+            }
+        case HCI_TYPE_EVNT: {
+                // Calculate the rest length of the data
+                STREAM_TO_UINT8((char *)(evnt_buff + SPI_HEADER_SIZE),
+                        HCI_EVENT_LENGTH_OFFSET, data_to_recv);
+                data_to_recv -= 1;
+
+                // Add padding byte if needed
+                if ((HEADERS_SIZE_EVNT + data_to_recv) & 1) {
+                    data_to_recv++;
+                }
+
+                if (data_to_recv) {
+                    SpiReadDataSynchronous(evnt_buff + 10, data_to_recv);
+                }
+
+                sSpiInformation.ulSpiState = eSPI_STATE_READ_EOT;
+                break;
+            }
+    }
+
+    return 0;
+}
+
+STATIC void SSIContReadOperation(void)
+{
+    // The header was read - continue with  the payload read
+    if (!SpiReadDataCont()) {
+        /* All the data was read - finalize handling by switching
+           to the task and calling from task Event Handler */
+        SpiTriggerRxProcessing();
+    }
+}
+
+STATIC mp_obj_t irq_callback(mp_obj_t line) {
+    DEBUG_printf("<< IRQ; state=%lu >>\n", sSpiInformation.ulSpiState);
+    switch (sSpiInformation.ulSpiState) {
+        case eSPI_STATE_POWERUP:
+            /* This means IRQ line was low call a callback of HCI Layer to inform on event */
+            DEBUG_printf(" - POWERUP\n");
+            sSpiInformation.ulSpiState = eSPI_STATE_INITIALIZED;
+            break;
+        case eSPI_STATE_IDLE:
+            DEBUG_printf(" - IDLE\n");
+            sSpiInformation.ulSpiState = eSPI_STATE_READ_IRQ;
+
+            /* IRQ line goes down - we are start reception */
+            CS_LOW();
+
+            // Wait for TX/RX Compete which will come as DMA interrupt
+            SpiReadHeader();
+
+            sSpiInformation.ulSpiState = eSPI_STATE_READ_EOT;
+
+            SSIContReadOperation();
+            break;
+        case eSPI_STATE_WRITE_IRQ:
+            DEBUG_printf(" - WRITE IRQ\n");
+            SpiWriteDataSynchronous(sSpiInformation.pTxPacket, sSpiInformation.usTxPacketLength);
+
+            sSpiInformation.ulSpiState = eSPI_STATE_IDLE;
+
+            CS_HIGH();
+            break;
+    }
+    return mp_const_none;
+}
+
+STATIC MP_DEFINE_CONST_FUN_OBJ_1(irq_callback_obj, irq_callback);
+
+void SpiPauseSpi(void) {
+    DEBUG_printf("SpiPauseSpi\n");
+    extint_disable(PIN_IRQ->pin);
+}
+
+void SpiResumeSpi(void) {
+    DEBUG_printf("SpiResumeSpi\n");
+    extint_enable(PIN_IRQ->pin);
+}

drivers/cc3000/src/evnt_handler.c

@@ -3,14 +3,6 @@
 *  evnt_handler.c  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend)
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -20,23 +12,23 @@
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
-*    documentation and/or other materials provided with the
+*    documentation and/or other materials provided with the   
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
-*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+*  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
+*  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+*  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
+*  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
+*  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+*  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
+*  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/
@@ -51,8 +43,6 @@
 //                  INCLUDE FILES
 //******************************************************************************
 
-#include <stdint.h>
-
 #include "cc3000_common.h"
 #include "string.h"
 #include "hci.h"
@@ -61,7 +51,6 @@
 #include "socket.h"
 #include "netapp.h"
 #include "ccspi.h"
-#include "ccdebug.h"
 
 
 
@@ -120,22 +109,22 @@
 #define GET_SCAN_RESULTS_FRAME_TIME_OFFSET				(10)
 #define GET_SCAN_RESULTS_SSID_MAC_LENGTH				(38)
 
-
+#define GET_MSS_VAL_RETVAL_OFFSET	(0)
 
 //*****************************************************************************
 //                  GLOBAL VARAIABLES
 //*****************************************************************************
 
-unsigned long socket_active_status = SOCKET_STATUS_INIT_VAL;
+UINT32 socket_active_status = SOCKET_STATUS_INIT_VAL; 
 
 
 //*****************************************************************************
 //            Prototypes for the static functions
 //*****************************************************************************
 
-static long hci_event_unsol_flowcontrol_handler(char *pEvent);
+static INT32 hci_event_unsol_flowcontrol_handler(CHAR *pEvent);
 
-static void update_socket_active_status(char *resp_params);
+static void update_socket_active_status(CHAR *resp_params);
 
 
 //*****************************************************************************
@@ -149,11 +138,11 @@ static void update_socket_active_status(char *resp_params);
 //!  @brief   Handle unsolicited event from type patch request
 //
 //*****************************************************************************
-void hci_unsol_handle_patch_request(char *event_hdr)
+void hci_unsol_handle_patch_request(CHAR *event_hdr)
 {
-	char *params = (char *)(event_hdr) + HCI_EVENT_HEADER_SIZE;
-	unsigned long ucLength = 0;
-	char *patch;
+	CHAR *params = (CHAR *)(event_hdr) + HCI_EVENT_HEADER_SIZE;
+	UINT32 ucLength = 0;
+	CHAR *patch;
 
 	switch (*params)
 	{
@@ -165,15 +154,15 @@ void hci_unsol_handle_patch_request(char *event_hdr)
 
 			if (patch)
 			{
-				hci_patch_send(HCI_EVENT_PATCHES_DRV_REQ,
-											 tSLInformation.pucTxCommandBuffer, patch, ucLength);
+				hci_patch_send(HCI_EVENT_PATCHES_DRV_REQ, 
+					tSLInformation.pucTxCommandBuffer, patch, ucLength);
 				return;
 			}
 		}
 
 		// Send 0 length Patches response event
-		hci_patch_send(HCI_EVENT_PATCHES_DRV_REQ,
-									 tSLInformation.pucTxCommandBuffer, 0, 0);
+		hci_patch_send(HCI_EVENT_PATCHES_DRV_REQ, 
+			tSLInformation.pucTxCommandBuffer, 0, 0);
 		break;
 
 	case HCI_EVENT_PATCHES_FW_REQ:
@@ -185,15 +174,15 @@ void hci_unsol_handle_patch_request(char *event_hdr)
 			// Build and send a patch
 			if (patch)
 			{
-				hci_patch_send(HCI_EVENT_PATCHES_FW_REQ,
-											 tSLInformation.pucTxCommandBuffer, patch, ucLength);
+				hci_patch_send(HCI_EVENT_PATCHES_FW_REQ, 
+					tSLInformation.pucTxCommandBuffer, patch, ucLength);
 				return;
 			}
 		}
 
 		// Send 0 length Patches response event
-		hci_patch_send(HCI_EVENT_PATCHES_FW_REQ,
-									 tSLInformation.pucTxCommandBuffer, 0, 0);
+		hci_patch_send(HCI_EVENT_PATCHES_FW_REQ, 
+			tSLInformation.pucTxCommandBuffer, 0, 0);
 		break;
 
 	case HCI_EVENT_PATCHES_BOOTLOAD_REQ:
@@ -204,15 +193,15 @@ void hci_unsol_handle_patch_request(char *event_hdr)
 
 			if (patch)
 			{
-				hci_patch_send(HCI_EVENT_PATCHES_BOOTLOAD_REQ,
-											 tSLInformation.pucTxCommandBuffer, patch, ucLength);
+				hci_patch_send(HCI_EVENT_PATCHES_BOOTLOAD_REQ,  
+					tSLInformation.pucTxCommandBuffer, patch, ucLength);
 				return;
 			}
 		}
 
 		// Send 0 length Patches response event
-		hci_patch_send(HCI_EVENT_PATCHES_BOOTLOAD_REQ,
-									 tSLInformation.pucTxCommandBuffer, 0, 0);
+		hci_patch_send(HCI_EVENT_PATCHES_BOOTLOAD_REQ, 
+			tSLInformation.pucTxCommandBuffer, 0, 0);
 		break;
 	}
 }
@@ -235,49 +224,45 @@ void hci_unsol_handle_patch_request(char *event_hdr)
 //*****************************************************************************
 
 
-unsigned char *
-hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
+UINT8 * hci_event_handler(void *pRetParams, UINT8 *from, UINT8 *fromlen)
 {
-	unsigned char *pucReceivedData, ucArgsize;
-	unsigned short usLength;
-	unsigned char *pucReceivedParams;
-	unsigned short usReceivedEventOpcode = 0;
-	unsigned long retValue32;
-	unsigned char * RecvParams;
-	unsigned char *RetParams;
+	UINT8 *pucReceivedData, ucArgsize;
+	UINT16 usLength;
+	UINT8 *pucReceivedParams;
+	UINT16 usReceivedEventOpcode = 0;
+	UINT32 retValue32;
+	UINT8 * RecvParams;
+	UINT8 *RetParams;
+
 
 	while (1)
 	{
-		cc3k_int_poll();
-
 		if (tSLInformation.usEventOrDataReceived != 0)
-		{
-
+		{				
 			pucReceivedData = (tSLInformation.pucReceivedData);
 
 			if (*pucReceivedData == HCI_TYPE_EVNT)
 			{
 				// Event Received
-				STREAM_TO_UINT16((char *)pucReceivedData,
-								HCI_EVENT_OPCODE_OFFSET,
-								usReceivedEventOpcode);
-				pucReceivedParams = pucReceivedData + HCI_EVENT_HEADER_SIZE;
+				STREAM_TO_UINT16((CHAR *)pucReceivedData, HCI_EVENT_OPCODE_OFFSET,
+					usReceivedEventOpcode);
+				pucReceivedParams = pucReceivedData + HCI_EVENT_HEADER_SIZE;		
 				RecvParams = pucReceivedParams;
-				RetParams = (unsigned char *)pRetParams;
+				RetParams = pRetParams;
 
 				// In case unsolicited event received - here the handling finished
-				if (hci_unsol_event_handler((char *)pucReceivedData) == 0)
+				if (hci_unsol_event_handler((CHAR *)pucReceivedData) == 0)
 				{
 					STREAM_TO_UINT8(pucReceivedData, HCI_DATA_LENGTH_OFFSET, usLength);
 
 					switch(usReceivedEventOpcode)
-					{
+					{		
 					case HCI_CMND_READ_BUFFER_SIZE:
 						{
-							STREAM_TO_UINT8((char *)pucReceivedParams, 0,
-											tSLInformation.usNumberOfFreeBuffers);
-							STREAM_TO_UINT16((char *)pucReceivedParams, 1,
-											tSLInformation.usSlBufferLength);
+							STREAM_TO_UINT8((CHAR *)pucReceivedParams, 0, 
+								tSLInformation.usNumberOfFreeBuffers);
+							STREAM_TO_UINT16((CHAR *)pucReceivedParams, 1, 
+								tSLInformation.usSlBufferLength);
 						}
 						break;
 
@@ -295,7 +280,7 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 					case HCI_EVNT_MDNS_ADVERTISE:
 
 						STREAM_TO_UINT8(pucReceivedData, HCI_EVENT_STATUS_OFFSET
-										,*(unsigned char *)pRetParams);
+							,*(UINT8 *)pRetParams);
 						break;
 
 					case HCI_CMND_SETSOCKOPT:
@@ -317,79 +302,86 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 					case HCI_EVNT_CONNECT:
 					case HCI_EVNT_NVMEM_WRITE:
 
-						STREAM_TO_UINT32((char *)pucReceivedParams,0
-										,*(unsigned long *)pRetParams);
+						STREAM_TO_UINT32((CHAR *)pucReceivedParams,0
+							,*(UINT32 *)pRetParams);
 						break;
 
 					case HCI_EVNT_READ_SP_VERSION:
 
 						STREAM_TO_UINT8(pucReceivedData, HCI_EVENT_STATUS_OFFSET
-										,*(unsigned char *)pRetParams);
-						pRetParams = ((char *)pRetParams) + 1;
-						STREAM_TO_UINT32((char *)pucReceivedParams, 0, retValue32);
-						UINT32_TO_STREAM((unsigned char *)pRetParams, retValue32);
+							,*(UINT8 *)pRetParams);
+						pRetParams = ((CHAR *)pRetParams) + 1;
+						STREAM_TO_UINT32((CHAR *)pucReceivedParams, 0, retValue32);
+						UINT32_TO_STREAM((UINT8 *)pRetParams, retValue32);				
 						break;
 
 					case HCI_EVNT_BSD_GETHOSTBYNAME:
 
-						STREAM_TO_UINT32((char *)pucReceivedParams
-						      ,GET_HOST_BY_NAME_RETVAL_OFFSET,*(unsigned long *)pRetParams);
-						pRetParams = ((char *)pRetParams) + 4;
-						STREAM_TO_UINT32((char *)pucReceivedParams
-									,GET_HOST_BY_NAME_ADDR_OFFSET,*(unsigned long *)pRetParams);
+						STREAM_TO_UINT32((CHAR *)pucReceivedParams
+							,GET_HOST_BY_NAME_RETVAL_OFFSET,*(UINT32 *)pRetParams);
+						pRetParams = ((CHAR *)pRetParams) + 4;
+						STREAM_TO_UINT32((CHAR *)pucReceivedParams
+							,GET_HOST_BY_NAME_ADDR_OFFSET,*(UINT32 *)pRetParams);					
+						break;
+
+					case HCI_EVNT_GETMSSVALUE:
+
+						STREAM_TO_UINT16((CHAR *)pucReceivedParams
+							,GET_MSS_VAL_RETVAL_OFFSET,*(UINT16 *)pRetParams);					
+
 						break;
 
 					case HCI_EVNT_ACCEPT:
 						{
-							STREAM_TO_UINT32((char *)pucReceivedParams,ACCEPT_SD_OFFSET
-															 ,*(unsigned long *)pRetParams);
-							pRetParams = ((char *)pRetParams) + 4;
-							STREAM_TO_UINT32((char *)pucReceivedParams
-										,ACCEPT_RETURN_STATUS_OFFSET,*(unsigned long *)pRetParams);
-              pRetParams = ((char *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,ACCEPT_SD_OFFSET
+								,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams
+								,ACCEPT_RETURN_STATUS_OFFSET,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4; 
 
 							//This argument returns in network order
-							memcpy((unsigned char *)pRetParams,
-								  pucReceivedParams + ACCEPT_ADDRESS__OFFSET, sizeof(sockaddr));
+							memcpy((UINT8 *)pRetParams, 
+								pucReceivedParams + ACCEPT_ADDRESS__OFFSET, sizeof(sockaddr));	
 							break;
 						}
 
 					case HCI_EVNT_RECV:
 					case HCI_EVNT_RECVFROM:
 						{
-						  STREAM_TO_UINT32((char *)pucReceivedParams,SL_RECEIVE_SD_OFFSET ,*(unsigned long *)pRetParams);
-						  pRetParams = ((char *)pRetParams) + 4;
-						  STREAM_TO_UINT32((char *)pucReceivedParams,SL_RECEIVE_NUM_BYTES_OFFSET,*(unsigned long *)pRetParams);
-						  pRetParams = ((char *)pRetParams) + 4;
-						  STREAM_TO_UINT32((char *)pucReceivedParams,SL_RECEIVE__FLAGS__OFFSET,*(unsigned long *)pRetParams);
-						  //tBsdReadReturnParams *tread = (tBsdReadReturnParams *)pRetParams; // unused
-						  if(((tBsdReadReturnParams *)pRetParams)->iNumberOfBytes == ERROR_SOCKET_INACTIVE)
-						    {
-						      set_socket_active_status(((tBsdReadReturnParams *)pRetParams)->iSocketDescriptor,SOCKET_STATUS_INACTIVE);
-						    }
-						  break;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SL_RECEIVE_SD_OFFSET ,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SL_RECEIVE_NUM_BYTES_OFFSET,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SL_RECEIVE__FLAGS__OFFSET,*(UINT32 *)pRetParams);
+
+							if(((tBsdReadReturnParams *)pRetParams)->iNumberOfBytes == ERROR_SOCKET_INACTIVE)
+							{
+								set_socket_active_status(((tBsdReadReturnParams *)pRetParams)->iSocketDescriptor,SOCKET_STATUS_INACTIVE);
+							}
+							break;
 						}
 
-                                        case HCI_EVNT_SEND:
+					case HCI_EVNT_SEND:
 					case HCI_EVNT_SENDTO:
 						{
-							STREAM_TO_UINT32((char *)pucReceivedParams,SL_RECEIVE_SD_OFFSET ,*(unsigned long *)pRetParams);
-							pRetParams = ((char *)pRetParams) + 4;
-							STREAM_TO_UINT32((char *)pucReceivedParams,SL_RECEIVE_NUM_BYTES_OFFSET,*(unsigned long *)pRetParams);
-							pRetParams = ((char *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SL_RECEIVE_SD_OFFSET ,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SL_RECEIVE_NUM_BYTES_OFFSET,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
 
 							break;
 						}
 
 					case HCI_EVNT_SELECT:
-						{
-							STREAM_TO_UINT32((char *)pucReceivedParams,SELECT_STATUS_OFFSET,*(unsigned long *)pRetParams);
-							pRetParams = ((char *)pRetParams) + 4;
-							STREAM_TO_UINT32((char *)pucReceivedParams,SELECT_READFD_OFFSET,*(unsigned long *)pRetParams);
-							pRetParams = ((char *)pRetParams) + 4;
-							STREAM_TO_UINT32((char *)pucReceivedParams,SELECT_WRITEFD_OFFSET,*(unsigned long *)pRetParams);
-							pRetParams = ((char *)pRetParams) + 4;
-							STREAM_TO_UINT32((char *)pucReceivedParams,SELECT_EXFD_OFFSET,*(unsigned long *)pRetParams);
+						{ 
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SELECT_STATUS_OFFSET,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SELECT_READFD_OFFSET,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SELECT_WRITEFD_OFFSET,*(UINT32 *)pRetParams);
+							pRetParams = ((CHAR *)pRetParams) + 4;
+							STREAM_TO_UINT32((CHAR *)pucReceivedParams,SELECT_EXFD_OFFSET,*(UINT32 *)pRetParams);			
 							break;
 						}
 
@@ -397,20 +389,20 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 
 						STREAM_TO_UINT8(pucReceivedData, HCI_EVENT_STATUS_OFFSET,((tBsdGetSockOptReturnParams *)pRetParams)->iStatus);
 						//This argument returns in network order
-						memcpy((unsigned char *)pRetParams, pucReceivedParams, 4);
+						memcpy((UINT8 *)pRetParams, pucReceivedParams, 4);
 						break;
 
 					case HCI_CMND_WLAN_IOCTL_GET_SCAN_RESULTS:
 
-						STREAM_TO_UINT32((char *)pucReceivedParams,GET_SCAN_RESULTS_TABlE_COUNT_OFFSET,*(unsigned long *)pRetParams);
-						pRetParams = ((char *)pRetParams) + 4;
-						STREAM_TO_UINT32((char *)pucReceivedParams,GET_SCAN_RESULTS_SCANRESULT_STATUS_OFFSET,*(unsigned long *)pRetParams);
-						pRetParams = ((char *)pRetParams) + 4;
-						STREAM_TO_UINT16((char *)pucReceivedParams,GET_SCAN_RESULTS_ISVALID_TO_SSIDLEN_OFFSET,*(unsigned long *)pRetParams);
-						pRetParams = ((char *)pRetParams) + 2;
-						STREAM_TO_UINT16((char *)pucReceivedParams,GET_SCAN_RESULTS_FRAME_TIME_OFFSET,*(unsigned long *)pRetParams);
-						pRetParams = ((char *)pRetParams) + 2;
-						memcpy((unsigned char *)pRetParams, (char *)(pucReceivedParams + GET_SCAN_RESULTS_FRAME_TIME_OFFSET + 2), GET_SCAN_RESULTS_SSID_MAC_LENGTH);
+						STREAM_TO_UINT32((CHAR *)pucReceivedParams,GET_SCAN_RESULTS_TABlE_COUNT_OFFSET,*(UINT32 *)pRetParams);
+						pRetParams = ((CHAR *)pRetParams) + 4;   					
+						STREAM_TO_UINT32((CHAR *)pucReceivedParams,GET_SCAN_RESULTS_SCANRESULT_STATUS_OFFSET,*(UINT32 *)pRetParams);
+						pRetParams = ((CHAR *)pRetParams) + 4;                                                        					
+						STREAM_TO_UINT16((CHAR *)pucReceivedParams,GET_SCAN_RESULTS_ISVALID_TO_SSIDLEN_OFFSET,*(UINT32 *)pRetParams);
+						pRetParams = ((CHAR *)pRetParams) + 2;   					
+						STREAM_TO_UINT16((CHAR *)pucReceivedParams,GET_SCAN_RESULTS_FRAME_TIME_OFFSET,*(UINT32 *)pRetParams);
+						pRetParams = ((CHAR *)pRetParams) + 2;  
+						memcpy((UINT8 *)pRetParams, (CHAR *)(pucReceivedParams + GET_SCAN_RESULTS_FRAME_TIME_OFFSET + 2), GET_SCAN_RESULTS_SSID_MAC_LENGTH);	
 						break;
 
 					case HCI_CMND_SIMPLE_LINK_START:
@@ -430,15 +422,15 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 						STREAM_TO_STREAM(RecvParams,RetParams,NETAPP_IPCONFIG_IP_LENGTH);
 						RecvParams += 4;
 
-						//Read DHCP server
+						//Read DHCP server                                          	
 						STREAM_TO_STREAM(RecvParams,RetParams,NETAPP_IPCONFIG_IP_LENGTH);
 						RecvParams += 4;
 
-						//Read DNS server
+						//Read DNS server                                           
 						STREAM_TO_STREAM(RecvParams,RetParams,NETAPP_IPCONFIG_IP_LENGTH);
 						RecvParams += 4;
 
-						//Read Mac address
+						//Read Mac address                            	
 						STREAM_TO_STREAM(RecvParams,RetParams,NETAPP_IPCONFIG_MAC_LENGTH);
 						RecvParams += 6;
 
@@ -454,22 +446,22 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 				}
 			}
 			else
-			{
+			{				
 				pucReceivedParams = pucReceivedData;
-				STREAM_TO_UINT8((char *)pucReceivedData, HCI_PACKET_ARGSIZE_OFFSET, ucArgsize);
+				STREAM_TO_UINT8((CHAR *)pucReceivedData, HCI_PACKET_ARGSIZE_OFFSET, ucArgsize);
 
-				STREAM_TO_UINT16((char *)pucReceivedData, HCI_PACKET_LENGTH_OFFSET, usLength);
+				STREAM_TO_UINT16((CHAR *)pucReceivedData, HCI_PACKET_LENGTH_OFFSET, usLength);
 
-				// Data received: note that the only case where from and from length
+				// Data received: note that the only case where from and from length 
 				// are not null is in recv from, so fill the args accordingly
 				if (from)
 				{
-					STREAM_TO_UINT32((char *)(pucReceivedData + HCI_DATA_HEADER_SIZE), BSD_RECV_FROM_FROMLEN_OFFSET, *(unsigned long *)fromlen);
+					STREAM_TO_UINT32((CHAR *)(pucReceivedData + HCI_DATA_HEADER_SIZE), BSD_RECV_FROM_FROMLEN_OFFSET, *(UINT32 *)fromlen);
 					memcpy(from, (pucReceivedData + HCI_DATA_HEADER_SIZE + BSD_RECV_FROM_FROM_OFFSET) ,*fromlen);
 				}
 
 				memcpy(pRetParams, pucReceivedParams + HCI_DATA_HEADER_SIZE + ucArgsize,
-							 usLength - ucArgsize);
+					usLength - ucArgsize);
 
 				tSLInformation.usRxDataPending = 0;
 			}
@@ -478,18 +470,18 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 
 			SpiResumeSpi();
 
-			// Since we are going to TX - we need to handle this event after the
+			// Since we are going to TX - we need to handle this event after the 
 			// ResumeSPi since we need interrupts
 			if ((*pucReceivedData == HCI_TYPE_EVNT) &&
-					(usReceivedEventOpcode == HCI_EVNT_PATCHES_REQ))
+				(usReceivedEventOpcode == HCI_EVNT_PATCHES_REQ))
 			{
-				hci_unsol_handle_patch_request((char *)pucReceivedData);
+				hci_unsol_handle_patch_request((CHAR *)pucReceivedData);
 			}
 
 			if ((tSLInformation.usRxEventOpcode == 0) && (tSLInformation.usRxDataPending == 0))
 			{
 				return NULL;
-			}
+			}	
 		}
 	}
 
@@ -507,19 +499,15 @@ hci_event_handler(void *pRetParams, unsigned char *from, unsigned char *fromlen)
 //!  @brief              Handle unsolicited events
 //
 //*****************************************************************************
-long
-hci_unsol_event_handler(char *event_hdr)
+INT32 hci_unsol_event_handler(CHAR *event_hdr)
 {
-	char * data = NULL;
-	long event_type;
-	unsigned long NumberOfReleasedPackets;
-	unsigned long NumberOfSentPackets;
+	CHAR * data = NULL;
+	INT32 event_type;
+	UINT32 NumberOfReleasedPackets;
+	UINT32 NumberOfSentPackets;
 
 	STREAM_TO_UINT16(event_hdr, HCI_EVENT_OPCODE_OFFSET,event_type);
 
-	DEBUGPRINT_F("\tHCI_UNSOL_EVT: ");
-	DEBUGPRINT_HEX16(event_type);
-
 	if (event_type & HCI_EVNT_UNSOL_BASE)
 	{
 		switch(event_type)
@@ -538,7 +526,7 @@ hci_unsol_event_handler(char *event_hdr)
 					{
 						tSLInformation.sWlanCB(HCI_EVENT_CC3000_CAN_SHUT_DOWN, NULL, 0);
 					}
-				}
+				}				
 				return 1;
 
 			}
@@ -546,7 +534,7 @@ hci_unsol_event_handler(char *event_hdr)
 	}
 
 	if(event_type & HCI_EVNT_WLAN_UNSOL_BASE)
-	{
+	{           
 		switch(event_type)
 		{
 		case HCI_EVNT_WLAN_KEEPALIVE:
@@ -563,10 +551,10 @@ hci_unsol_event_handler(char *event_hdr)
 
 		case HCI_EVNT_WLAN_UNSOL_DHCP:
 			{
-				unsigned char	params[NETAPP_IPCONFIG_MAC_OFFSET + 1];	// extra byte is for the status
-				unsigned char *recParams = params;
+				UINT8	params[NETAPP_IPCONFIG_MAC_OFFSET + 1];	// extra byte is for the status
+				UINT8 *recParams = params;
 
-				data = (char*)(event_hdr) + HCI_EVENT_HEADER_SIZE;
+				data = (CHAR*)(event_hdr) + HCI_EVENT_HEADER_SIZE;
 
 				//Read IP address
 				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH);
@@ -575,92 +563,87 @@ hci_unsol_event_handler(char *event_hdr)
 				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH);
 				data += 4;
 				//Read default GW
-				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH);
+				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH); 
 				data += 4;
-				//Read DHCP server
-				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH);
+				//Read DHCP server  
+				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH);     
 				data += 4;
-				//Read DNS server
-				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH);
+				//Read DNS server  
+				STREAM_TO_STREAM(data,recParams,NETAPP_IPCONFIG_IP_LENGTH); 
 				// read the status
 				STREAM_TO_UINT8(event_hdr, HCI_EVENT_STATUS_OFFSET, *recParams);
 
 
 				if( tSLInformation.sWlanCB )
 				{
-					tSLInformation.sWlanCB(event_type, (char *)params, sizeof(params));
+					tSLInformation.sWlanCB(event_type, (CHAR *)params, sizeof(params));
 				}
 			}
 			break;
 
 		case HCI_EVNT_WLAN_ASYNC_PING_REPORT:
 			{
-				netapp_pingreport_args_t params;
-				data = (char*)(event_hdr) + HCI_EVENT_HEADER_SIZE;
-				STREAM_TO_UINT32(data, NETAPP_PING_PACKETS_SENT_OFFSET, params.packets_sent);
-				STREAM_TO_UINT32(data, NETAPP_PING_PACKETS_RCVD_OFFSET, params.packets_received);
-				STREAM_TO_UINT32(data, NETAPP_PING_MIN_RTT_OFFSET, params.min_round_time);
-				STREAM_TO_UINT32(data, NETAPP_PING_MAX_RTT_OFFSET, params.max_round_time);
+				netapp_pingreport_args_t params;			
+				data = (CHAR*)(event_hdr) + HCI_EVENT_HEADER_SIZE;			
+				STREAM_TO_UINT32(data, NETAPP_PING_PACKETS_SENT_OFFSET, params.packets_sent);			
+				STREAM_TO_UINT32(data, NETAPP_PING_PACKETS_RCVD_OFFSET, params.packets_received);			
+				STREAM_TO_UINT32(data, NETAPP_PING_MIN_RTT_OFFSET, params.min_round_time);		
+				STREAM_TO_UINT32(data, NETAPP_PING_MAX_RTT_OFFSET, params.max_round_time);	
 				STREAM_TO_UINT32(data, NETAPP_PING_AVG_RTT_OFFSET, params.avg_round_time);
 
 				if( tSLInformation.sWlanCB )
 				{
-					tSLInformation.sWlanCB(event_type, (char *)&params, sizeof(params));
+					tSLInformation.sWlanCB(event_type, (CHAR *)&params, sizeof(params));
 				}
 			}
 			break;
 		case HCI_EVNT_BSD_TCP_CLOSE_WAIT:
 			{
-			  DEBUGPRINT_F("\tTCP Close Wait\n\r");
-			  uint8_t socketnum;
-			  data = (char*)(event_hdr) + HCI_EVENT_HEADER_SIZE;
-			  /*
-			  printHex(data[0]); PRINT_F("\t");
-			  printHex(data[1]); PRINT_F("\t");
-			  printHex(data[2]); PRINT_F("\t");
-			  printHex(data[3]); PRINT_F("\t");
-			  printHex(data[4]); PRINT_F("\t");
-			  printHex(data[5]); PRINT_F("\t");
-			  */
-			  socketnum = data[0];
-			  //STREAM_TO_UINT16(data, 0, socketnum);
-			  if( tSLInformation.sWlanCB )
-			    {
-			      tSLInformation.sWlanCB(event_type, (char *)&socketnum, 1);
-			    }
+				data = (CHAR *)(event_hdr) + HCI_EVENT_HEADER_SIZE;
+				if( tSLInformation.sWlanCB )
+				{
+					//data[0] represents the socket id, for which FIN was received by remote.
+					//Upon receiving this event, the user can close the socket, or else the 
+					//socket will be closded after inacvitity timeout (by default 60 seconds)
+					tSLInformation.sWlanCB(event_type, data, 1);
+				}
 			}
 			break;
 
-		//'default' case which means "event not supported"
-		default:
+			//'default' case which means "event not supported" 	
+		default: 
 			return (0);
 		}
 		return(1);
 	}
 
 	if ((event_type == HCI_EVNT_SEND) || (event_type == HCI_EVNT_SENDTO)
-			|| (event_type == HCI_EVNT_WRITE))
+		|| (event_type == HCI_EVNT_WRITE))
 	{
-                char *pArg;
-                long status;
+		CHAR *pArg;
+		INT32 status;
 
-		DEBUGPRINT_F("\tSEND event response\n\r");
+		pArg = M_BSD_RESP_PARAMS_OFFSET(event_hdr);
+		STREAM_TO_UINT32(pArg, BSD_RSP_PARAMS_STATUS_OFFSET,status);
 
-                pArg = M_BSD_RESP_PARAMS_OFFSET(event_hdr);
-                STREAM_TO_UINT32(pArg, BSD_RSP_PARAMS_STATUS_OFFSET,status);
+		if (ERROR_SOCKET_INACTIVE == status)
+		{
+			// The only synchronous event that can come from SL device in form of 
+			// command complete is "Command Complete" on data sent, in case SL device 
+			// was unable to transmit
+			STREAM_TO_UINT8(event_hdr, HCI_EVENT_STATUS_OFFSET, tSLInformation.slTransmitDataError);
+			update_socket_active_status(M_BSD_RESP_PARAMS_OFFSET(event_hdr));
 
-                if (ERROR_SOCKET_INACTIVE == status)
-                {
-                    // The only synchronous event that can come from SL device in form of
-                    // command complete is "Command Complete" on data sent, in case SL device
-                    // was unable to transmit
-                    STREAM_TO_UINT8(event_hdr, HCI_EVENT_STATUS_OFFSET, tSLInformation.slTransmitDataError);
-                    update_socket_active_status(M_BSD_RESP_PARAMS_OFFSET(event_hdr));
+			return (1);
+		}
+		else
+			return (0);
+	}
 
-                    return (1);
-                }
-                else
-                    return (0);
+	//handle a case where unsolicited event arrived, but was not handled by any of the cases above
+	if ((event_type != tSLInformation.usRxEventOpcode) && (event_type != HCI_EVNT_PATCHES_REQ))
+	{
+		return(1);
 	}
 
 	return(0);
@@ -674,29 +657,28 @@ hci_unsol_event_handler(char *event_hdr)
 //!
 //!  @return         ESUCCESS if successful, EFAIL if an error occurred
 //!
-//!  @brief          Parse the incoming unsolicited event packets and issues
+//!  @brief          Parse the incoming unsolicited event packets and issues 
 //!                  corresponding event handler.
 //
 //*****************************************************************************
-long
-hci_unsolicited_event_handler(void)
+INT32 hci_unsolicited_event_handler(void)
 {
-	unsigned long   res = 0;
-	unsigned char *pucReceivedData;
+	UINT32   res = 0;
+	UINT8 *pucReceivedData;
 
 	if (tSLInformation.usEventOrDataReceived != 0)
 	{
 		pucReceivedData = (tSLInformation.pucReceivedData);
 
 		if (*pucReceivedData == HCI_TYPE_EVNT)
-		{
+		{			
 
 			// In case unsolicited event received - here the handling finished
-			if (hci_unsol_event_handler((char *)pucReceivedData) == 1)
+			if (hci_unsol_event_handler((CHAR *)pucReceivedData) == 1)
 			{
 
 				// There was an unsolicited event received - we can release the buffer
-				// and clean the event received
+				// and clean the event received 
 				tSLInformation.usEventOrDataReceived = 0;
 
 				res = 1;
@@ -716,11 +698,11 @@ hci_unsolicited_event_handler(void)
 //!	 @param Status
 //!  @return         none
 //!
-//!  @brief          Check if the socket ID and status are valid and set
+//!  @brief          Check if the socket ID and status are valid and set 
 //!                  accordingly  the global socket status
 //
 //*****************************************************************************
-void set_socket_active_status(long Sd, long Status)
+void set_socket_active_status(INT32 Sd, INT32 Status)
 {
 	if(M_IS_VALID_SD(Sd) && M_IS_VALID_STATUS(Status))
 	{
@@ -743,25 +725,24 @@ void set_socket_active_status(long Sd, long Status)
 //!					 number of free buffer in the SL device.
 //
 //*****************************************************************************
-long
-hci_event_unsol_flowcontrol_handler(char *pEvent)
+INT32 hci_event_unsol_flowcontrol_handler(CHAR *pEvent)
 {
 
-	long temp, value;
-	unsigned short i;
-	unsigned short  pusNumberOfHandles=0;
-	char *pReadPayload;
+	INT32 temp, value;
+	UINT16 i;
+	UINT16  pusNumberOfHandles=0;
+	CHAR *pReadPayload;
 
-	STREAM_TO_UINT16((char *)pEvent,HCI_EVENT_HEADER_SIZE,pusNumberOfHandles);
-	pReadPayload = ((char *)pEvent +
-									HCI_EVENT_HEADER_SIZE + sizeof(pusNumberOfHandles));
+	STREAM_TO_UINT16((CHAR *)pEvent,HCI_EVENT_HEADER_SIZE,pusNumberOfHandles);
+	pReadPayload = ((CHAR *)pEvent +
+		HCI_EVENT_HEADER_SIZE + sizeof(pusNumberOfHandles));	
 	temp = 0;
 
 	for(i = 0; i < pusNumberOfHandles ; i++)
 	{
 		STREAM_TO_UINT16(pReadPayload, FLOW_CONTROL_EVENT_FREE_BUFFS_OFFSET, value);
 		temp += value;
-		pReadPayload += FLOW_CONTROL_EVENT_SIZE;
+		pReadPayload += FLOW_CONTROL_EVENT_SIZE;  
 	}
 
 	tSLInformation.usNumberOfFreeBuffers += temp;
@@ -775,14 +756,13 @@ hci_event_unsol_flowcontrol_handler(char *pEvent)
 //!  get_socket_active_status
 //!
 //!  @param  Sd  Socket IS
-//!  @return     Current status of the socket.
+//!  @return     Current status of the socket.   
 //!
 //!  @brief  Retrieve socket status
 //
 //*****************************************************************************
 
-long
-get_socket_active_status(long Sd)
+INT32 get_socket_active_status(INT32 Sd)
 {
 	if(M_IS_VALID_SD(Sd))
 	{
@@ -796,15 +776,14 @@ get_socket_active_status(long Sd)
 //!  update_socket_active_status
 //!
 //!  @param  resp_params  Socket IS
-//!  @return     Current status of the socket.
+//!  @return     Current status of the socket.   
 //!
 //!  @brief  Retrieve socket status
 //
 //*****************************************************************************
-void
-update_socket_active_status(char *resp_params)
+void update_socket_active_status(CHAR *resp_params)
 {
-	long status, sd;
+	INT32 status, sd;
 
 	STREAM_TO_UINT32(resp_params, BSD_RSP_PARAMS_SOCKET_OFFSET,sd);
 	STREAM_TO_UINT32(resp_params, BSD_RSP_PARAMS_STATUS_OFFSET,status);
@@ -830,10 +809,9 @@ update_socket_active_status(char *resp_params)
 //
 //*****************************************************************************
 
-void
-SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams)
+void SimpleLinkWaitEvent(UINT16 usOpcode, void *pRetParams)
 {
-	// In the blocking implementation the control to caller will be returned only
+	// In the blocking implementation the control to caller will be returned only 
 	// after the end of current transaction
 	tSLInformation.usRxEventOpcode = usOpcode;
 	hci_event_handler(pRetParams, 0, 0);
@@ -850,16 +828,14 @@ SimpleLinkWaitEvent(unsigned short usOpcode, void *pRetParams)
 //!  @return               none
 //!
 //!  @brief                Wait for data, pass it to the hci_event_handler
-//! 					   and update in a global variable that there is
+//! 					   and update in a global variable that there is 
 //!						   data to read.
 //
 //*****************************************************************************
 
-void
-SimpleLinkWaitData(unsigned char *pBuf, unsigned char *from,
-									 unsigned char *fromlen)
+void SimpleLinkWaitData(UINT8 *pBuf, UINT8 *from, UINT8 *fromlen)
 {
-	// In the blocking implementation the control to caller will be returned only
+	// In the blocking implementation the control to caller will be returned only 
 	// after the end of current transaction, i.e. only after data will be received
 	tSLInformation.usRxDataPending = 1;
 	hci_event_handler(pBuf, from, fromlen);

drivers/cc3000/src/hci.c

@@ -3,14 +3,6 @@
 *  hci.c  - CC3000 Host Driver Implementation.
 *  Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
 *
-* Adapted for use with the Arduino/AVR by KTOWN (Kevin Townsend) 
-* & Limor Fried for Adafruit Industries
-* This library works with the Adafruit CC3000 breakout 
-*	----> https://www.adafruit.com/products/1469
-* Adafruit invests time and resources providing this open source code,
-* please support Adafruit and open-source hardware by purchasing
-* products from Adafruit!
-*
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
@@ -48,9 +40,7 @@
 //
 //*****************************************************************************
 
-#include <stdint.h>
-#include <string.h> // for memcpy
-
+#include <string.h>
 #include "cc3000_common.h"
 #include "hci.h"
 #include "ccspi.h"
@@ -73,21 +63,19 @@
 //!  @brief               Initiate an HCI command.
 //
 //*****************************************************************************
-unsigned short 
-hci_command_send(unsigned short usOpcode, unsigned char *pucBuff,
-                     unsigned char ucArgsLength)
+UINT16 hci_command_send(UINT16 usOpcode, UINT8 *pucBuff, UINT8 ucArgsLength)
 { 
-	unsigned char *stream;
-	
+	UINT8 *stream;
+
 	stream = (pucBuff + SPI_HEADER_SIZE);
-	
+
 	UINT8_TO_STREAM(stream, HCI_TYPE_CMND);
 	stream = UINT16_TO_STREAM(stream, usOpcode);
 	UINT8_TO_STREAM(stream, ucArgsLength);
-	
+
 	//Update the opcode of the event we will be waiting for
 	SpiWrite(pucBuff, ucArgsLength + SIMPLE_LINK_HCI_CMND_HEADER_SIZE);
-	
+
 	return(0);
 }
 
@@ -106,26 +94,25 @@ hci_command_send(unsigned short usOpcode, unsigned char *pucBuff,
 //!  @brief              Initiate an HCI data write operation
 //
 //*****************************************************************************
-long
-hci_data_send(unsigned char ucOpcode, 
-							unsigned char *ucArgs,
-							unsigned short usArgsLength, 
-							unsigned short usDataLength,
-							const unsigned char *ucTail,
-							unsigned short usTailLength)
+INT32 hci_data_send(UINT8 ucOpcode, 
+	UINT8 *ucArgs,
+	UINT16 usArgsLength, 
+	UINT16 usDataLength,
+	const UINT8 *ucTail,
+	UINT16 usTailLength)
 {
-	unsigned char *stream;
-	
+	UINT8 *stream;
+
 	stream = ((ucArgs) + SPI_HEADER_SIZE);
-	
+
 	UINT8_TO_STREAM(stream, HCI_TYPE_DATA);
 	UINT8_TO_STREAM(stream, ucOpcode);
 	UINT8_TO_STREAM(stream, usArgsLength);
 	stream = UINT16_TO_STREAM(stream, usArgsLength + usDataLength + usTailLength);
-	
+
 	// Send the packet over the SPI
 	SpiWrite(ucArgs, SIMPLE_LINK_HCI_DATA_HEADER_SIZE + usArgsLength + usDataLength + usTailLength);
-	
+
 	return(ESUCCESS);
 }
 
@@ -144,19 +131,18 @@ hci_data_send(unsigned char ucOpcode,
 //!  @brief              Prepeare HCI header and initiate an HCI data write operation
 //
 //*****************************************************************************
-void hci_data_command_send(unsigned short usOpcode, unsigned char *pucBuff,
-                     unsigned char ucArgsLength,unsigned short ucDataLength)
+void hci_data_command_send(UINT16 usOpcode, UINT8 *pucBuff, UINT8 ucArgsLength,UINT16 ucDataLength)
 { 
- 	unsigned char *stream = (pucBuff + SPI_HEADER_SIZE);
-	
+	UINT8 *stream = (pucBuff + SPI_HEADER_SIZE);
+
 	UINT8_TO_STREAM(stream, HCI_TYPE_DATA);
 	UINT8_TO_STREAM(stream, usOpcode);
 	UINT8_TO_STREAM(stream, ucArgsLength);
 	stream = UINT16_TO_STREAM(stream, ucArgsLength + ucDataLength);
-	
+
 	// Send the command over SPI on data channel
 	SpiWrite(pucBuff, ucArgsLength + ucDataLength + SIMPLE_LINK_HCI_DATA_CMND_HEADER_SIZE);
-	
+
 	return;
 }
 
@@ -174,61 +160,58 @@ void hci_data_command_send(unsigned short usOpcode, unsigned char *pucBuff,
 //!  @brief               Prepeare HCI header and initiate an HCI patch write operation
 //
 //*****************************************************************************
-void
-hci_patch_send(unsigned char ucOpcode, unsigned char *pucBuff, char *patch, unsigned short usDataLength)
+void hci_patch_send(UINT8 ucOpcode, UINT8 *pucBuff, CHAR *patch, UINT16 usDataLength)
 { 
- 	unsigned char *data_ptr = (pucBuff + SPI_HEADER_SIZE);
-	unsigned short usTransLength;
-	unsigned char *stream = (pucBuff + SPI_HEADER_SIZE);
-	
+	UINT8 *data_ptr = (pucBuff + SPI_HEADER_SIZE);
+	UINT16 usTransLength;
+	UINT8 *stream = (pucBuff + SPI_HEADER_SIZE);
+
 	UINT8_TO_STREAM(stream, HCI_TYPE_PATCH);
 	UINT8_TO_STREAM(stream, ucOpcode);
 	stream = UINT16_TO_STREAM(stream, usDataLength + SIMPLE_LINK_HCI_PATCH_HEADER_SIZE);
-	
+
 	if (usDataLength <= SL_PATCH_PORTION_SIZE)
 	{
 		UINT16_TO_STREAM(stream, usDataLength);
 		stream = UINT16_TO_STREAM(stream, usDataLength);
 		memcpy((pucBuff + SPI_HEADER_SIZE) + HCI_PATCH_HEADER_SIZE, patch, usDataLength);
-		
+
 		// Update the opcode of the event we will be waiting for
 		SpiWrite(pucBuff, usDataLength + HCI_PATCH_HEADER_SIZE);
 	}
 	else
 	{
-		
+
 		usTransLength = (usDataLength/SL_PATCH_PORTION_SIZE);
 		UINT16_TO_STREAM(stream, usDataLength + SIMPLE_LINK_HCI_PATCH_HEADER_SIZE + usTransLength*SIMPLE_LINK_HCI_PATCH_HEADER_SIZE);
 		stream = UINT16_TO_STREAM(stream, SL_PATCH_PORTION_SIZE);
 		memcpy(pucBuff + SPI_HEADER_SIZE + HCI_PATCH_HEADER_SIZE, patch, SL_PATCH_PORTION_SIZE);
 		usDataLength -= SL_PATCH_PORTION_SIZE;
 		patch += SL_PATCH_PORTION_SIZE;
-		
+
 		// Update the opcode of the event we will be waiting for
 		SpiWrite(pucBuff, SL_PATCH_PORTION_SIZE + HCI_PATCH_HEADER_SIZE);
-		
+
 		while (usDataLength)
 		{
-			cc3k_int_poll();
-
 			if (usDataLength <= SL_PATCH_PORTION_SIZE)
 			{
 				usTransLength = usDataLength;
 				usDataLength = 0;
-				
+
 			}
 			else
 			{
 				usTransLength = SL_PATCH_PORTION_SIZE;
 				usDataLength -= usTransLength;
 			}
-			
-			*(unsigned short *)data_ptr = usTransLength;
+
+			*(UINT16 *)data_ptr = usTransLength;
 			memcpy(data_ptr + SIMPLE_LINK_HCI_PATCH_HEADER_SIZE, patch, usTransLength);
 			patch += usTransLength;
-			
+
 			// Update the opcode of the event we will be waiting for
-			SpiWrite((unsigned char *)data_ptr, usTransLength + sizeof(usTransLength));
+			SpiWrite((UINT8 *)data_ptr, usTransLength + sizeof(usTransLength));
 		}
 	}
 }