Merge pull request #78 from FoamyGuy/update_frequency

Use higher frequency values

.gitattributes

@@ -0,0 +1,11 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+.py text eol=lf
+.rst text eol=lf
+.txt text eol=lf
+.yaml text eol=lf
+.toml text eol=lf
+.license text eol=lf
+.md text eol=lf

.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: 2021 Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+Thank you for contributing! Before you submit a pull request, please read the following.
+
+Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html
+
+If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
+
+Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
+
+Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.

.github/workflows/build.yml

@@ -10,68 +10,5 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-    - name: Dump GitHub context
-      env:
-        GITHUB_CONTEXT: ${{ toJson(github) }}
-      run: echo "$GITHUB_CONTEXT"
-    - name: Translate Repo Name For Build Tools filename_prefix
-      id: repo-name
-      run: |
-        echo ::set-output name=repo-name::$(
-        echo ${{ github.repository }} |
-        awk -F '\/' '{ print tolower($2) }' |
-        tr '_' '-'
-        )
-    - name: Set up Python 3.6
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.6
-    - name: Versions
-      run: |
-        python3 --version
-    - name: Checkout Current Repo
-      uses: actions/checkout@v1
-      with:
-        submodules: true
-    - name: Checkout tools repo
-      uses: actions/checkout@v2
-      with:
-        repository: adafruit/actions-ci-circuitpython-libs
-        path: actions-ci
-    - name: Install dependencies
-      # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.)
-      run: |
-        source actions-ci/install.sh
-    - name: Pip install pylint, Sphinx, pre-commit
-      run: |
-        pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
-    - name: Library version
-      run: git describe --dirty --always --tags
-    - name: Pre-commit hooks
-      run: |
-        pre-commit run --all-files
-    - name: Run tests
-      run: |
-        cd tests/ && python -m unittest discover
-        cd ..
-    - name: Build assets
-      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
-    - name: Archive bundles
-      uses: actions/upload-artifact@v2
-      with:
-        name: bundles
-        path: ${{ github.workspace }}/bundles/
-    - name: Build docs
-      working-directory: docs
-      run: sphinx-build -E -W -b html . _build/html
-    - name: Check For setup.py
-      id: need-pypi
-      run: |
-        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
-    - name: Build Python package
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
-      run: |
-        pip install --upgrade setuptools wheel twine readme_renderer testresources
-        python setup.py sdist
-        python setup.py bdist_wheel --universal
-        twine check dist/*
+    - name: Run Build CI workflow
+      uses: adafruit/workflows-circuitpython-libs/build@main

.github/workflows/failure-help-text.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: Failure help text
+
+on:
+  workflow_run:
+    workflows: ["Build CI"]
+    types:
+      - completed
+
+jobs:
+  post-help:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
+    steps:
+    - name: Post comment to help
+      uses: adafruit/circuitpython-action-library-ci-failed@v1

.github/workflows/release.yml

@@ -1,85 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: MIT
-
-name: Release Actions
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  upload-release-assets:
-    runs-on: ubuntu-latest
-    steps:
-    - name: Dump GitHub context
-      env:
-        GITHUB_CONTEXT: ${{ toJson(github) }}
-      run: echo "$GITHUB_CONTEXT"
-    - name: Translate Repo Name For Build Tools filename_prefix
-      id: repo-name
-      run: |
-        echo ::set-output name=repo-name::$(
-        echo ${{ github.repository }} |
-        awk -F '\/' '{ print tolower($2) }' |
-        tr '_' '-'
-        )
-    - name: Set up Python 3.6
-      uses: actions/setup-python@v1
-      with:
-        python-version: 3.6
-    - name: Versions
-      run: |
-        python3 --version
-    - name: Checkout Current Repo
-      uses: actions/checkout@v1
-      with:
-        submodules: true
-    - name: Checkout tools repo
-      uses: actions/checkout@v2
-      with:
-        repository: adafruit/actions-ci-circuitpython-libs
-        path: actions-ci
-    - name: Install deps
-      run: |
-        source actions-ci/install.sh
-    - name: Build assets
-      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
-    - name: Upload Release Assets
-      # the 'official' actions version does not yet support dynamically
-      # supplying asset names to upload. @csexton's version chosen based on
-      # discussion in the issue below, as its the simplest to implement and
-      # allows for selecting files with a pattern.
-      # https://github.com/actions/upload-release-asset/issues/4
-      #uses: actions/upload-release-asset@v1.0.1
-      uses: csexton/release-asset-action@master
-      with:
-        pattern: "bundles/*"
-        github-token: ${{ secrets.GITHUB_TOKEN }}
-
-  upload-pypi:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v1
-    - name: Check For setup.py
-      id: need-pypi
-      run: |
-        echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
-    - name: Set up Python
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
-      uses: actions/setup-python@v1
-      with:
-        python-version: '3.x'
-    - name: Install dependencies
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
-      run: |
-        python -m pip install --upgrade pip
-        pip install setuptools wheel twine
-    - name: Build and publish
-      if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
-      env:
-        TWINE_USERNAME: ${{ secrets.pypi_username }}
-        TWINE_PASSWORD: ${{ secrets.pypi_password }}
-      run: |
-        python setup.py sdist
-        twine upload dist/*

.github/workflows/release_gh.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: GitHub Release Actions
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  upload-release-assets:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Run GitHub Release CI workflow
+      uses: adafruit/workflows-circuitpython-libs/release-gh@main
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        upload-url: ${{ github.event.release.upload_url }}

.github/workflows/release_pypi.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+name: PyPI Release Actions
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  upload-release-assets:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Run PyPI Release CI workflow
+      uses: adafruit/workflows-circuitpython-libs/release-pypi@main
+      with:
+        pypi-username: ${{ secrets.pypi_username }}
+        pypi-password: ${{ secrets.pypi_password }}

.gitignore

@@ -1,18 +1,48 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
+# Do not include files and directories created by your personal work environment, such as the IDE
+# you use, except for those already listed here. Pull requests including changes to this file will
+# not be accepted.
+
+# This .gitignore file contains rules for files generated by working with CircuitPython libraries,
+# including building Sphinx, testing with pip, and creating a virual environment, as well as the
+# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs.
+
+# If you find that there are files being generated on your machine that should not be included in
+# your git commit, you should create a .gitignore_global file on your computer to include the
+# files created by your personal setup. To do so, follow the two steps below.
+
+# First, create a file called .gitignore_global somewhere convenient for you, and add rules for
+# the files you want to exclude from git commits.
+
+# Second, configure Git to use the exclude file for all Git repositories by running the
+# following via commandline, replacing "path/to/your/" with the actual path to your newly created
+# .gitignore_global file:
+# git config --global core.excludesfile path/to/your/.gitignore_global
+
+# CircuitPython-specific files
 *.mpy
-.idea
+
+# Python-specific files
 __pycache__
-_build
 *.pyc
+
+# Sphinx build-specific files
+_build
+
+# This file results from running `pip -e install .` in a local repository
+*.egg-info
+
+# Virtual environment-specific files
 .env
-.python-version
-build*/
-bundles
+.venv
+
+# MacOS-specific files
 *.DS_Store
-.eggs
-dist
-**/*.egg-info
+
+# IDE-specific files
+.idea
 .vscode
+*~

.pre-commit-config.yaml

@@ -1,34 +1,21 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
 #
 # SPDX-License-Identifier: Unlicense
 
 repos:
--   repo: https://github.com/python/black
-    rev: 20.8b1
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
     hooks:
-    - id: black
--   repo: https://github.com/fsfe/reuse-tool
-    rev: v0.12.1
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-    - id: reuse
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+      - id: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
     hooks:
-    -   id: check-yaml
-    -   id: end-of-file-fixer
-    -   id: trailing-whitespace
--   repo: https://github.com/pycqa/pylint
-    rev: pylint-2.7.1
-    hooks:
-    -   id: pylint
-        name: pylint (library code)
-        types: [python]
-        exclude: "^(docs/|examples/|setup.py$)"
--   repo: local
-    hooks:
-    -   id: pylint_examples
-        name: pylint (examples code)
-        description: Run pylint rules on "examples/*.py" files
-        entry: /usr/bin/env bash -c
-        args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)']
-        language: system
+      - id: reuse

.pylintrc

@@ -1,436 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
-
-[MASTER]
-
-# A comma-separated list of package or module names from where C extensions may
-# be loaded. Extensions are loading into the active Python interpreter and may
-# run arbitrary code
-extension-pkg-whitelist=
-
-# Add files or directories to the ignore-list. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the ignore-list. The
-# regex matches against base names, not paths.
-ignore-patterns=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Use multiple processes to speed up Pylint.
-jobs=1
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-# Pickle collected data for later comparisons.
-persistent=yes
-
-# Specify a configuration file.
-#rcfile=
-
-# Allow loading of arbitrary C extensions. Extensions are imported into the
-# active Python interpreter and may run arbitrary code.
-unsafe-load-any-extension=no
-
-
-[MESSAGES CONTROL]
-
-# Only show warnings with the listed confidence levels. Leave empty to show
-# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED
-confidence=
-
-# Disable the message, report, category or checker with the given id(s). You
-# can either give multiple identifiers separated by comma (,) or put this
-# option multiple times (only on the command line, not in the configuration
-# file where it should appear only once).You can also use "--disable=all" to
-# disable everything first and then reenable specific checks. For example, if
-# you want to run only the similarities checker, you can use "--disable=all
-# --enable=similarities". If you want to run only the classes checker, but have
-# no Warning level messages displayed, use"--disable=all --enable=classes
-# --disable=W"
-# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call
-disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,pointless-string-statement
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# multiple time (only on the command line, not in the configuration file where
-# it should appear only once). See also the "--disable" option for examples.
-enable=
-
-
-[REPORTS]
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (RP0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Template used to display messages. This is a python new-style format string
-# used to format the message information. See doc for all details
-#msg-template=
-
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio).You can also give a reporter class, eg
-# mypackage.mymodule.MyReporterClass.
-output-format=text
-
-# Tells whether to display a full report or only the messages
-reports=no
-
-# Activate the evaluation score.
-score=yes
-
-
-[REFACTORING]
-
-# Maximum number of nested blocks for function / method body
-max-nested-blocks=5
-
-
-[LOGGING]
-
-# Logging modules to check that the string format arguments are in logging
-# function parameter format
-logging-modules=logging
-
-
-[SPELLING]
-
-# Spelling dictionary name. Available dictionaries: none. To make it working
-# install python-enchant package.
-spelling-dict=
-
-# List of comma separated words that should not be checked.
-spelling-ignore-words=
-
-# A path to a file that contains private dictionary; one word per line.
-spelling-private-dict-file=
-
-# Tells whether to store unknown words to indicated private dictionary in
-# --spelling-private-dict-file option instead of raising a message.
-spelling-store-unknown-words=no
-
-
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-# notes=FIXME,XXX,TODO
-notes=FIXME,XXX
-
-
-[TYPECHECK]
-
-# List of decorators that produce context managers, such as
-# contextlib.contextmanager. Add to this list to register other decorators that
-# produce valid context managers.
-contextmanager-decorators=contextlib.contextmanager
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E1101 when accessed. Python regular
-# expressions are accepted.
-generated-members=
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# This flag controls whether pylint should warn about no-member and similar
-# checks whenever an opaque object is returned when inferring. The inference
-# can return multiple potential results while evaluating a Python object, but
-# some branches might not be evaluated, which results in partial inference. In
-# that case, it might be useful to still emit no-member and other checks for
-# the rest of the inferred objects.
-ignore-on-opaque-inference=yes
-
-# List of class names for which member attributes should not be checked (useful
-# for classes with dynamically set attributes). This supports the use of
-# qualified names.
-ignored-classes=optparse.Values,thread._local,_thread._local
-
-# List of module names for which member attributes should not be checked
-# (useful for modules/projects where namespaces are manipulated during runtime
-# and thus existing member attributes cannot be deduced by static analysis. It
-# supports qualified module names, as well as Unix pattern matching.
-ignored-modules=board
-
-# Show a hint with possible names when a member name was not found. The aspect
-# of finding the hint is based on edit distance.
-missing-member-hint=yes
-
-# The minimum edit distance a name should have in order to be considered a
-# similar match for a missing member name.
-missing-member-hint-distance=1
-
-# The total number of similar names that should be taken in consideration when
-# showing a hint for a missing member.
-missing-member-max-choices=1
-
-
-[VARIABLES]
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-# Tells whether unused global variables should be treated as a violation.
-allow-global-unused-variables=yes
-
-# List of strings which can identify a callback function by name. A callback
-# name must start or end with one of those strings.
-callbacks=cb_,_cb
-
-# A regular expression matching the name of dummy variables (i.e. expectedly
-# not used).
-dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
-
-# Argument names that match this expression will be ignored. Default to name
-# with leading underscore
-ignored-argument-names=_.*|^ignored_|^unused_
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=no
-
-# List of qualified module names which can have objects that can redefine
-# builtins.
-redefining-builtins-modules=six.moves,future.builtins
-
-
-[FORMAT]
-
-# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
-# expected-line-ending-format=
-expected-line-ending-format=LF
-
-# Regexp for a line that is allowed to be longer than the limit.
-ignore-long-lines=^\s*(# )?<?https?://\S+>?$
-
-# Number of spaces of indent required inside a hanging  or continued line.
-indent-after-paren=4
-
-# String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-# Maximum number of characters on a single line.
-max-line-length=100
-
-# Maximum number of lines in a module
-max-module-lines=1000
-
-# List of optional constructs for which whitespace checking is disabled. `dict-
-# separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
-# `trailing-comma` allows a space between comma and closing bracket: (a, ).
-# `empty-line` allows space-only lines.
-no-space-check=trailing-comma,dict-separator
-
-# Allow the body of a class to be on the same line as the declaration if body
-# contains single statement.
-single-line-class-stmt=no
-
-# Allow the body of an if to be on the same line as the test if there is no
-# else.
-single-line-if-stmt=no
-
-
-[SIMILARITIES]
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-# Ignore imports when computing similarities.
-ignore-imports=yes
-
-# Minimum lines number of a similarity.
-min-similarity-lines=12
-
-
-[BASIC]
-
-# Naming hint for argument names
-argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct argument names
-argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Naming hint for attribute names
-attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct attribute names
-attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# Naming hint for class attribute names
-class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Naming hint for class names
-# class-name-hint=[A-Z_][a-zA-Z0-9]+$
-class-name-hint=[A-Z_][a-zA-Z0-9_]+$
-
-# Regular expression matching correct class names
-# class-rgx=[A-Z_][a-zA-Z0-9]+$
-class-rgx=[A-Z_][a-zA-Z0-9_]+$
-
-# Naming hint for constant names
-const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Regular expression matching correct constant names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Minimum line length for functions/classes that require docstrings, shorter
-# ones are exempt.
-docstring-min-length=-1
-
-# Naming hint for function names
-function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct function names
-function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Good variable names which should always be accepted, separated by a comma
-# good-names=i,j,k,ex,Run,_
-good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_
-
-# Include a hint for the correct naming format with invalid-name
-include-naming-hint=no
-
-# Naming hint for inline iteration names
-inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Naming hint for method names
-method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Naming hint for module names
-module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Regular expression matching correct module names
-module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$
-
-# Colon-delimited sets of names that determine each other's naming style when
-# the name regexes allow several styles.
-name-group=
-
-# Regular expression which should only match function or class names that do
-# not require a docstring.
-no-docstring-rgx=^_
-
-# List of decorators that produce properties, such as abc.abstractproperty. Add
-# to this list to register other decorators that produce valid properties.
-property-classes=abc.abstractproperty
-
-# Naming hint for variable names
-variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-# Regular expression matching correct variable names
-variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$
-
-
-[IMPORTS]
-
-# Allow wildcard imports from modules that define __all__.
-allow-wildcard-with-all=no
-
-# Analyse import fallback blocks. This can be used to support both Python 2 and
-# 3 compatible code, which means that the block might have code that exists
-# only in one or another interpreter, leading to false positives when analysed.
-analyse-fallback-blocks=no
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=optparse,tkinter.tix
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-# Force import order to recognize a module as part of the standard
-# compatibility libraries.
-known-standard-library=
-
-# Force import order to recognize a module as part of a third party library.
-known-third-party=enchant
-
-
-[CLASSES]
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-# List of member names, which should be excluded from the protected access
-# warning.
-exclude-protected=_asdict,_fields,_replace,_source,_make
-
-# List of valid names for the first argument in a class method.
-valid-classmethod-first-arg=cls
-
-# List of valid names for the first argument in a metaclass class method.
-valid-metaclass-classmethod-first-arg=mcs
-
-
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Maximum number of attributes for a class (see R0902).
-# max-attributes=7
-max-attributes=11
-
-# Maximum number of boolean expressions in a if statement
-max-bool-expr=5
-
-# Maximum number of branch for function / method body
-max-branches=12
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=1
-
-
-[EXCEPTIONS]
-
-# Exceptions that will emit a warning when being caught. Defaults to
-# "Exception"
-overgeneral-exceptions=Exception

.readthedocs.yaml

@@ -0,0 +1,22 @@
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+sphinx:
+  configuration: docs/conf.py
+
+build:
+  os: ubuntu-lts-latest
+  tools:
+    python: "3"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - requirements: requirements.txt

.readthedocs.yml

@@ -1,7 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-#
-# SPDX-License-Identifier: Unlicense
-
-python:
-    version: 3
-requirements_file: requirements.txt

LICENSES/BSD-3-Clause.txt

@@ -0,0 +1,11 @@
+Copyright (c) <year> <owner>.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. 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.
+
+3. Neither the name of the copyright holder 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 HOLDER 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.

README.rst

@@ -2,10 +2,10 @@ Introduction
 ============
 
 .. image:: https://readthedocs.org/projects/adafruit-circuitpython-pioasm/badge/?version=latest
-    :target: https://circuitpython.readthedocs.io/projects/pioasm/en/latest/
+    :target: https://docs.circuitpython.org/projects/pioasm/en/latest/
     :alt: Documentation Status
 
-.. image:: https://img.shields.io/discord/327254708534116352.svg
+.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
     :target: https://adafru.it/discord
     :alt: Discord
 
@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/actions
     :alt: Build Status
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Code Style: Ruff
 
 Simple assembler to convert pioasm to bytes
 
@@ -32,8 +32,6 @@ This is easily achieved by downloading
 
 Installing from PyPI
 =====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
 
 On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
 PyPI <https://pypi.org/project/adafruit-circuitpython-pioasm/>`_. To install for current user:
@@ -53,8 +51,8 @@ To install in a virtual environment in your current project:
 .. code-block:: shell
 
     mkdir project-name && cd project-name
-    python3 -m venv .env
-    source .env/bin/activate
+    python3 -m venv .venv
+    source .venv/bin/activate
     pip3 install adafruit-circuitpython-pioasm
 
 Usage Example
@@ -77,7 +75,7 @@ Usage Example
 
     sm = rp2pio.StateMachine(
         assembled,
-        frequency=80,
+        frequency=4000,
         init=adafruit_pioasm.assemble("set pindirs 1"),
         first_set_pin=board.LED,
     )
@@ -85,14 +83,16 @@ Usage Example
 
     time.sleep(120)
 
+Documentation
+=============
+
+API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/pioasm/en/latest/>`_.
+
+For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
+
 Contributing
 ============
 
 Contributions are welcome! Please read our `Code of Conduct
 <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/blob/master/CODE_OF_CONDUCT.md>`_
 before contributing to help this project stay welcoming.
-
-Documentation
-=============
-
-For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

adafruit_pioasm.py

@@ -11,167 +11,549 @@ Simple assembler to convert pioasm to bytes
 * Author(s): Scott Shawcroft
 """
 
+try:
+    from typing import Any, List, Sequence
+except ImportError:
+    pass
+
 import array
 import re
 
 splitter = re.compile(r",\s*|\s+(?:,\s*)?").split
+mov_splitter = re.compile("!|~|::").split
 
-__version__ = "0.0.0-auto.0"
+__version__ = "0.0.0+auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PIOASM.git"
 
 CONDITIONS = ["", "!x", "x--", "!y", "y--", "x!=y", "pin", "!osre"]
 IN_SOURCES = ["pins", "x", "y", "null", None, None, "isr", "osr"]
 OUT_DESTINATIONS = ["pins", "x", "y", "null", "pindirs", "pc", "isr", "exec"]
 WAIT_SOURCES = ["gpio", "pin", "irq", None]
-MOV_DESTINATIONS = ["pins", "x", "y", None, "exec", "pc", "isr", "osr"]
+MOV_DESTINATIONS_V0 = ["pins", "x", "y", None, "exec", "pc", "isr", "osr"]
+MOV_DESTINATIONS_V1 = ["pins", "x", "y", "pindirs", "exec", "pc", "isr", "osr"]
 MOV_SOURCES = ["pins", "x", "y", "null", None, "status", "isr", "osr"]
 MOV_OPS = [None, "~", "::", None]
 SET_DESTINATIONS = ["pins", "x", "y", None, "pindirs", None, None, None]
+FIFO_TYPES = {
+    "auto": 0,
+    "txrx": 0,
+    "tx": 0,
+    "rx": 0,
+    "txput": 1,
+    "txget": 1,
+    "putget": 1,
+}
 
 
-def assemble(text_program):
-    """Converts pioasm text to encoded instruction bytes"""
-    # pylint: disable=too-many-branches,too-many-statements,too-many-locals
-    assembled = []
-    program_name = None
-    labels = {}
-    instructions = []
-    sideset_count = 0
-    for line in text_program.split("\n"):
-        line = line.strip()
-        if not line:
-            continue
-        if ";" in line:
+class Program:
+    """Encapsulates a program's instruction stream and configuration flags
+
+    Example::
+
+        program = adafruit_pioasm.Program(...)
+        state_machine = rp2pio.StateMachine(program.assembled, ..., **program.pio_kwargs)
+
+    """
+
+    assembled: array.array
+    """The assembled PIO program instructions"""
+    public_labels: dict[str, int]
+    """The offset of any labels declared public"""
+    pio_kwargs: dict[str, Any]
+    """Settings from assembler directives to pass to the StateMachine constructor"""
+
+    def __init__(self, text_program: str, *, build_debuginfo: bool = False) -> None:
+        """Converts pioasm text to encoded instruction bytes"""
+        assembled: List[int] = []
+        program_name = None
+        labels = {}
+        public_labels = {}
+        linemap = []
+        instructions: List[str] = []
+        sideset_count = 0
+        sideset_enable = 0
+        sideset_pindirs = False
+        wrap = None
+        wrap_target = None
+        offset = -1
+        pio_version = 0
+        fifo_type = "auto"
+        mov_status_type = None
+        mov_status_n = None
+        in_count = None
+        in_shift_right = None
+        auto_push = None
+        push_threshold = None
+        out_count = None
+        out_shift_right = None
+        auto_pull = None
+        pull_threshold = None
+        set_count = None
+
+        def require_before_instruction():
+            if len(instructions) != 0:
+                raise RuntimeError(f"{words[0]} must be before first instruction")
+
+        def require_version(required_version, instruction):
+            if pio_version < required_version:
+                raise RuntimeError(f"{instruction} requires .pio_version {required_version}")
+
+        def int_in_range(arg, low, high, what, radix=0):
+            result = int(arg, radix)
+            if low <= result < high:
+                return result
+            raise RuntimeError(f"{what} must be at least {low} and less than {high}, got {result}")
+
+        def parse_rxfifo_brackets(arg, fifo_dir):
+            require_version(1, line)
+            if fifo_type != "putget" and fifo_type != fifo_dir:
+                raise RuntimeError(
+                    f"FIFO must be configured for '{fifo_dir}' or 'putget' for {line}"
+                )
+            if arg.endswith("[y]"):
+                return 0b1000
+            return int_in_range(arg[7:-1], 0, 8, "rxfifo index")
+
+        for i, line in enumerate(text_program.split("\n")):
             line = line.split(";")[0].strip()
-        if line.startswith(".program"):
-            if program_name:
-                raise RuntimeError("Multiple programs not supported")
-            program_name = line.split()[1]
-        elif line.startswith(".wrap_target"):
-            if len(instructions) > 0:
-                raise RuntimeError("wrap_target not supported")
-        elif line.startswith(".wrap"):
-            pass
-        elif line.startswith(".side_set"):
-            sideset_count = int(line.split()[1])
-        elif line.endswith(":"):
-            label = line[:-1]
-            if label in labels:
-                raise SyntaxError(f"Duplicate label {repr(label)}")
-            labels[label] = len(instructions)
-        elif line:
-            # Only add as an instruction if the line isn't empty
-            instructions.append(line)
+            if not line:
+                continue
+            words = line.split()
+            if line.startswith(".program"):
+                if program_name:
+                    raise RuntimeError("Multiple programs not supported")
+                program_name = line.split()[1]
+            elif line.startswith(".pio_version"):
+                require_before_instruction()
+                pio_version = int_in_range(words[1], 0, 2, ".pio_version")
+            elif line.startswith(".origin"):
+                require_before_instruction()
+                offset = int_in_range(words[1], 0, 32, ".origin")
+            elif line.startswith(".wrap_target"):
+                wrap_target = len(instructions)
+            elif line.startswith(".wrap"):
+                if len(instructions) == 0:
+                    raise RuntimeError("Cannot have .wrap as first instruction")
+                wrap = len(instructions) - 1
+            elif line.startswith(".side_set"):
+                sideset_count = int(line.split()[1], 0)
+                sideset_enable = "opt" in line
+                sideset_pindirs = "pindirs" in line
+            elif line.startswith(".fifo"):
+                require_before_instruction()
+                fifo_type = line.split()[1]
+                required_version = FIFO_TYPES.get(fifo_type)
+                if required_version is None:
+                    raise RuntimeError(f"Invalid fifo type {fifo_type}")
+                require_version(required_version, line)
+            elif line.startswith(".mov_status"):
+                require_before_instruction()
+                required_version = 0
+                mov_status_n = 0
+                mov_status_type = words[1]
+                if words[1] in {"txfifo", "rxfifo"}:
+                    if words[2] != "<":
+                        raise RuntimeError(f"Invalid {line}")
+                    mov_status_n = int_in_range(words[3], 0, 32, words[1])
+                elif words[1] == "irq":
+                    required_version = 1
+                    idx = 2
+                    if words[idx] == "next":
+                        mov_status_n = 0x10
+                        idx += 1
+                    elif words[idx] == "prev":
+                        mov_status_n = 0x8
+                        idx += 1
+                    else:
+                        mov_status_n = 0
+                    if words[idx] != "set":
+                        raise RuntimeError(f"Invalid {line})")
+                    mov_status_n |= int_in_range(words[idx + 1], 0, 8, "mov_status irq")
+                require_version(required_version, line)
+            elif words[0] == ".out":
+                require_before_instruction()
+                out_count = int_in_range(words[1], 1, 33, ".out count")
+                auto_pull = False
 
-    max_delay = 2 ** (5 - sideset_count) - 1
-    assembled = []
-    for instruction in instructions:
-        # print(instruction)
-        instruction = splitter(instruction.strip())
-        delay = 0
-        if instruction[-1].endswith("]"):  # Delay
-            delay = int(instruction[-1].strip("[]"))
-            if delay > max_delay:
-                raise RuntimeError("Delay too long:", delay)
-            instruction.pop()
-        if len(instruction) > 1 and instruction[-2] == "side":
-            sideset_value = int(instruction[-1])
-            if sideset_value > 2 ** sideset_count:
-                raise RuntimeError("Sideset value too large")
-            delay |= sideset_value << (5 - sideset_count)
-            instruction.pop()
-            instruction.pop()
+                idx = 2
+                if idx < len(words) and words[idx] == "left":
+                    out_shift_right = False
+                    idx += 1
+                elif idx < len(words) and words[idx] == "right":
+                    out_shift_right = True
+                    idx += 1
 
-        if instruction[0] == "nop":
-            #                  mov delay   y op   y
-            assembled.append(0b101_00000_010_00_010)
-        elif instruction[0] == "jmp":
-            #                instr delay cnd addr
-            assembled.append(0b000_00000_000_00000)
-            target = instruction[-1]
-            if target[:1] in "0123456789":
-                assembled[-1] |= int(target)
-            elif instruction[-1] in labels:
-                assembled[-1] |= labels[target]
-            else:
-                raise SyntaxError(f"Invalid jmp target {repr(target)}")
+                if idx < len(words) and words[idx] == "auto":
+                    auto_pull = True
+                    idx += 1
 
-            if len(instruction) > 2:
-                assembled[-1] |= CONDITIONS.index(instruction[1]) << 5
+                if idx < len(words):
+                    pull_threshold = int_in_range(words[idx], 1, 33, ".out threshold")
+                    idx += 1
 
-        elif instruction[0] == "wait":
-            #                instr delay p sr index
-            assembled.append(0b001_00000_0_00_00000)
-            polarity = int(instruction[1])
-            if not 0 <= polarity <= 1:
-                raise RuntimeError("Invalid polarity")
-            assembled[-1] |= polarity << 7
-            assembled[-1] |= WAIT_SOURCES.index(instruction[2]) << 5
-            num = int(instruction[3])
-            if not 0 <= num <= 31:
-                raise RuntimeError("Wait num out of range")
-            assembled[-1] |= num
-            if instruction[-1] == "rel":
-                assembled[-1] |= 0x10  # Set the high bit of the irq value
-        elif instruction[0] == "in":
-            #                instr delay src count
-            assembled.append(0b010_00000_000_00000)
-            assembled[-1] |= IN_SOURCES.index(instruction[1]) << 5
-            count = int(instruction[-1])
-            if not 1 <= count <= 32:
-                raise RuntimeError("Count out of range")
-            assembled[-1] |= count & 0x1F  # 32 is 00000 so we mask the top
-        elif instruction[0] == "out":
-            #                instr delay dst count
-            assembled.append(0b011_00000_000_00000)
-            assembled[-1] |= OUT_DESTINATIONS.index(instruction[1]) << 5
-            count = int(instruction[-1])
-            if not 1 <= count <= 32:
-                raise RuntimeError("Count out of range")
-            assembled[-1] |= count & 0x1F  # 32 is 00000 so we mask the top
-        elif instruction[0] == "push" or instruction[0] == "pull":
-            #                instr delay d i b zero
-            assembled.append(0b100_00000_0_0_0_00000)
-            if instruction[0] == "pull":
-                assembled[-1] |= 0x80
-            if instruction[-1] == "block" or not instruction[-1].endswith("block"):
-                assembled[-1] |= 0x20
-            if len(instruction) > 1 and instruction[1] in ("ifempty", "iffull"):
-                assembled[-1] |= 0x40
-        elif instruction[0] == "mov":
-            #                instr delay dst op src
-            assembled.append(0b101_00000_000_00_000)
-            assembled[-1] |= MOV_DESTINATIONS.index(instruction[1]) << 5
-            assembled[-1] |= MOV_SOURCES.index(instruction[-1])
-            if len(instruction) > 3:
-                assembled[-1] |= MOV_OPS.index(instruction[-2]) << 3
-        elif instruction[0] == "irq":
-            #                instr delay z c w index
-            assembled.append(0b110_00000_0_0_0_00000)
-            if instruction[-1] == "rel":
-                assembled[-1] |= 0x10  # Set the high bit of the irq value
-                instruction.pop()
-            num = int(instruction[-1])
-            if not 0 <= num <= 7:
-                raise RuntimeError("Interrupt index out of range")
-            assembled[-1] |= num
-            if len(instruction) == 3:  # after rel has been removed
-                if instruction[1] == "wait":
-                    assembled[-1] |= 0x20
-                elif instruction[1] == "clear":
-                    assembled[-1] |= 0x40
-                # All other values are the default of set without waiting
-        elif instruction[0] == "set":
-            #                instr delay dst data
-            assembled.append(0b111_00000_000_00000)
-            assembled[-1] |= SET_DESTINATIONS.index(instruction[1]) << 5
-            value = int(instruction[-1])
-            if not 0 <= value <= 31:
-                raise RuntimeError("Set value out of range")
-            assembled[-1] |= value
+            elif words[0] == ".in":
+                require_before_instruction()
+                in_count = int_in_range(words[1], 32 if pio_version == 0 else 1, 33, ".in count")
+                auto_push = False
+
+                idx = 2
+                if idx < len(words) and words[idx] == "left":
+                    in_shift_right = False
+                    idx += 1
+                elif idx < len(words) and words[idx] == "right":
+                    in_shift_right = True
+                    idx += 1
+
+                if idx < len(words) and words[idx] == "auto":
+                    auto_push = True
+                    idx += 1
+
+                if idx < len(words):
+                    push_threshold = int_in_range(words[idx], 1, 33, ".in threshold")
+                    idx += 1
+
+            elif words[0] == ".set":
+                require_before_instruction()
+                set_count = int_in_range(words[1], 5 if pio_version == 0 else 1, 6, ".set count")
+
+            elif line.endswith(":"):
+                label = line[:-1]
+                if line.startswith("public "):
+                    label = label[7:]
+                    public_labels[label] = len(instructions)
+                if label in labels:
+                    raise SyntaxError(f"Duplicate label {repr(label)}")
+                labels[label] = len(instructions)
+            elif line:
+                # Only add as an instruction if the line isn't empty
+                instructions.append(line)
+                linemap.append(i)
+
+        mov_destinations: Sequence[str | None]
+        if pio_version >= 1:
+            mov_destinations = MOV_DESTINATIONS_V1
         else:
-            raise RuntimeError("Unknown instruction:" + instruction[0])
-        assembled[-1] |= delay << 8
-    # print(hex(assembled[-1]))
+            mov_destinations = MOV_DESTINATIONS_V0
 
-    return array.array("H", assembled)
+        max_delay = 2 ** (5 - sideset_count - sideset_enable) - 1
+        assembled = []
+        for line in instructions:
+            instruction = splitter(line.strip())
+            delay = 0
+            if (
+                len(instruction) > 1
+                and instruction[-1].startswith("[")
+                and instruction[-1].endswith("]")
+            ):  # Delay
+                delay = int(instruction[-1].strip("[]"), 0)
+                if delay < 0:
+                    raise RuntimeError("Delay negative:", delay)
+                if delay > max_delay:
+                    raise RuntimeError("Delay too long:", delay)
+                instruction.pop()
+            if len(instruction) > 2 and instruction[-2] == "side":
+                if sideset_count == 0:
+                    raise RuntimeError("No side_set count set")
+                sideset_value = int(instruction[-1], 0)
+                if sideset_value >= 2**sideset_count:
+                    raise RuntimeError("Sideset value too large")
+                delay |= sideset_value << (5 - sideset_count - sideset_enable)
+                delay |= sideset_enable << 4
+                instruction.pop()
+                instruction.pop()
+
+            if instruction[0] == "nop":
+                #                  mov delay   y op   y
+                assembled.append(0b101_00000_010_00_010)
+            elif instruction[0] == "jmp":
+                #                instr delay cnd addr
+                assembled.append(0b000_00000_000_00000)
+                target = instruction[-1]
+                if target[:1] in "0123456789":
+                    assembled[-1] |= int(target, 0)
+                elif instruction[-1] in labels:
+                    assembled[-1] |= labels[target]
+                else:
+                    raise SyntaxError(f"Invalid jmp target {repr(target)}")
+
+                if len(instruction) > 2:
+                    try:
+                        assembled[-1] |= CONDITIONS.index(instruction[1]) << 5
+                    except ValueError as exc:
+                        raise ValueError(f"Invalid jmp condition '{instruction[1]}'") from exc
+
+            elif instruction[0] == "wait":
+                #                instr delay p sr index
+                assembled.append(0b001_00000_0_00_00000)
+                polarity = int(instruction[1], 0)
+                source = instruction[2]
+                if not 0 <= polarity <= 1:
+                    raise RuntimeError("Invalid polarity")
+                assembled[-1] |= polarity << 7
+                if instruction[2] == "jmppin":
+                    require_version(1, "wait jmppin")
+                    num = 0
+                    if len(instruction) > 3:
+                        if len(instruction) < 5 or instruction[3] != "+":
+                            raise RuntimeError("invalid wait jmppin")
+                        num = int_in_range(instruction[4], 0, 4, "wait jmppin offset")
+                    assembled[-1] |= num
+                    assembled[-1] |= 0b11 << 5  # JMPPIN wait source
+                else:
+                    idx = 3
+                    assembled[-1] |= WAIT_SOURCES.index(instruction[2]) << 5
+                    if source == "irq":
+                        if instruction[idx] == "next":
+                            require_version(1, "wait irq next")
+                            assembled[-1] |= 0b11000
+                            idx += 1
+                        elif instruction[idx] == "prev":
+                            require_version(1, "wait irq prev")
+                            assembled[-1] |= 0b01000
+                            idx += 1
+
+                        limit = 8
+                        # The flag index is decoded in the same way as the IRQ
+                        # index field, decoding down from the two MSBs
+                        if instruction[-1] == "rel":
+                            if assembled[-1] & 0b11000:
+                                raise RuntimeError("cannot use next/prev with rel")
+                            assembled[-1] |= 0b10000
+                    else:
+                        limit = 32
+                    num = int_in_range(instruction[idx], 0, limit, "wait {instruction[2]}")
+                    assembled[-1] |= num
+
+            elif instruction[0] == "in":
+                #                instr delay src count
+                assembled.append(0b010_00000_000_00000)
+                source = instruction[1]
+                try:
+                    assembled[-1] |= IN_SOURCES.index(source) << 5
+                except ValueError as exc:
+                    raise ValueError(f"Invalid in source '{source}'") from exc
+                count = int(instruction[-1], 0)
+                if not 1 <= count <= 32:
+                    raise RuntimeError("Count out of range")
+                assembled[-1] |= count & 0x1F  # 32 is 00000 so we mask the top
+            elif instruction[0] == "out":
+                #                instr delay dst count
+                assembled.append(0b011_00000_000_00000)
+                destination = instruction[1]
+                try:
+                    assembled[-1] |= OUT_DESTINATIONS.index(destination) << 5
+                except ValueError as exc:
+                    raise ValueError(f"Invalid out destination '{destination}'") from exc
+                count = int(instruction[-1], 0)
+                if not 1 <= count <= 32:
+                    raise RuntimeError("Count out of range")
+                assembled[-1] |= count & 0x1F  # 32 is 00000 so we mask the top
+            elif instruction[0] == "push" or instruction[0] == "pull":
+                #                instr delay d i b zero
+                assembled.append(0b100_00000_0_0_0_00000)
+                if instruction[0] == "pull":
+                    assembled[-1] |= 0x80
+                if instruction[-1] == "block" or not instruction[-1].endswith("block"):
+                    assembled[-1] |= 0x20
+                if len(instruction) > 1 and instruction[1] in {"ifempty", "iffull"}:
+                    assembled[-1] |= 0x40
+            elif instruction[0] == "mov":
+                #                instr delay dst op src
+                if instruction[1].startswith("rxfifo["):  # mov rxfifo[], isr
+                    assembled.append(0b100_00000_0001_1_000)
+                    if instruction[2] != "isr":
+                        raise ValueError("mov rxfifo[] source must be isr")
+                    assembled[-1] ^= parse_rxfifo_brackets(instruction[1], "txput")
+                elif instruction[2].startswith("rxfifo["):  # mov osr, rxfifo[]
+                    assembled.append(0b100_00000_1001_1_000)
+                    if instruction[1] != "osr":
+                        raise ValueError("mov ,rxfifo[] target must be osr")
+                    assembled[-1] ^= parse_rxfifo_brackets(instruction[2], "txget")
+                else:
+                    assembled.append(0b101_00000_000_00_000)
+                    assembled[-1] |= mov_destinations.index(instruction[1]) << 5
+                    source = instruction[-1]
+                    source_split = mov_splitter(source)
+                    if len(source_split) == 1:
+                        try:
+                            assembled[-1] |= MOV_SOURCES.index(source)
+                        except ValueError as exc:
+                            raise ValueError(f"Invalid mov source '{source}'") from exc
+                    else:
+                        assembled[-1] |= MOV_SOURCES.index(source_split[1])
+                        if source[:1] == "!":
+                            assembled[-1] |= 0x08
+                        elif source[:1] == "~":
+                            assembled[-1] |= 0x08
+                        elif source[:2] == "::":
+                            assembled[-1] |= 0x10
+                        else:
+                            raise RuntimeError("Invalid mov operator:", source[:1])
+                    if len(instruction) > 3:
+                        assembled[-1] |= MOV_OPS.index(instruction[-2]) << 3
+            elif instruction[0] == "irq":
+                #                instr delay z c w tp/idx
+                assembled.append(0b110_00000_0_0_0_00000)
+
+                irq_type = 0
+                idx = 1
+                if instruction[idx] == "wait":
+                    assembled[-1] |= 0x20
+                    idx += 1
+                elif instruction[idx] == "clear":
+                    assembled[-1] |= 0x40
+                    idx += 1
+
+                if instruction[idx] == "prev":
+                    irq_type = 1
+                    require_version(1, "irq prev")
+                    idx += 1
+                elif instruction[idx] == "next":
+                    irq_type = 3
+                    require_version(1, "irq next")
+                    idx += 1
+
+                if instruction[-1] == "rel":
+                    if irq_type != 0:
+                        raise RuntimeError("cannot use next/prev with rel")
+                    irq_type = 2
+                    instruction.pop()
+
+                assembled[-1] |= irq_type << 3
+
+                num = int_in_range(instruction[idx], 0, 8, "irq index")
+                assembled[-1] |= num
+                instruction.pop()
+
+            elif instruction[0] == "set":
+                #                instr delay dst data
+                assembled.append(0b111_00000_000_00000)
+                try:
+                    assembled[-1] |= SET_DESTINATIONS.index(instruction[1]) << 5
+                except ValueError as exc:
+                    raise ValueError(f"Invalid set destination '{instruction[1]}'") from exc
+                value = int(instruction[-1], 0)
+                if not 0 <= value <= 31:
+                    raise RuntimeError("Set value out of range")
+                assembled[-1] |= value
+            else:
+                raise RuntimeError(f"Unknown instruction: {instruction[0]}")
+            assembled[-1] |= delay << 8
+            # print(bin(assembled[-1]))
+
+        self.pio_kwargs = {
+            "sideset_enable": sideset_enable,
+        }
+
+        if offset != -1:
+            self.pio_kwargs["offset"] = offset
+
+        if pio_version != 0:
+            self.pio_kwargs["pio_version"] = pio_version
+
+        if sideset_count != 0:
+            self.pio_kwargs["sideset_pin_count"] = sideset_count
+        if sideset_pindirs:
+            self.pio_kwargs["sideset_pindirs"] = sideset_pindirs
+
+        if wrap is not None:
+            self.pio_kwargs["wrap"] = wrap
+        if wrap_target is not None:
+            self.pio_kwargs["wrap_target"] = wrap_target
+
+        if fifo_type != "auto":
+            self.pio_kwargs["fifo_type"] = fifo_type
+
+        if mov_status_type is not None:
+            self.pio_kwargs["mov_status_type"] = mov_status_type
+            self.pio_kwargs["mov_status_n"] = mov_status_n
+
+        if set_count is not None:
+            self.pio_kwargs["set_pin_count"] = set_count
+
+        if out_count not in {None, 32}:
+            self.pio_kwargs["out_pin_count"] = out_count
+
+        if out_shift_right is not None:
+            self.pio_kwargs["out_shift_right"] = out_shift_right
+
+        if auto_pull is not None:
+            self.pio_kwargs["auto_pull"] = auto_pull
+
+        if pull_threshold is not None:
+            self.pio_kwargs["pull_threshold"] = pull_threshold
+
+        if in_count not in {None, 32}:
+            self.pio_kwargs["in_pin_count"] = in_count
+
+        if in_shift_right is not None:
+            self.pio_kwargs["in_shift_right"] = in_shift_right
+
+        if auto_push is not None:
+            self.pio_kwargs["auto_push"] = auto_push
+
+        if push_threshold is not None:
+            self.pio_kwargs["push_threshold"] = push_threshold
+
+        self.assembled = array.array("H", assembled)
+
+        self.debuginfo = (linemap, text_program) if build_debuginfo else None
+
+        self.public_labels = public_labels
+
+    @classmethod
+    def from_file(cls, filename: str, **kwargs) -> "Program":
+        """Assemble a PIO program in a file"""
+        with open(filename, encoding="utf-8") as i:
+            program = i.read()
+        return cls(program, **kwargs)
+
+    def print_c_program(self, name: str, qualifier: str = "const") -> None:
+        """Print the program into a C program snippet"""
+        if self.debuginfo is None:
+            linemap = []
+            program_lines = []
+        else:
+            linemap = self.debuginfo[0][:]  # Use a copy since we destroy it
+            program_lines = self.debuginfo[1].split("\n")
+
+        print(
+            f"{qualifier} int {name}_wrap = {self.pio_kwargs.get('wrap', len(self.assembled)-1)};"
+        )
+        print(f"{qualifier} int {name}_wrap_target = {self.pio_kwargs.get('wrap_target', 0)};")
+        sideset_pin_count = self.pio_kwargs.get("sideset_pin_count", 0)
+        print(f"{qualifier} int {name}_sideset_pin_count = {sideset_pin_count};")
+        print(f"{qualifier} bool {name}_sideset_enable = {+self.pio_kwargs['sideset_enable']};")
+        print(f"{qualifier} uint16_t {name}[] = " + "{")
+        last_line = 0
+        if linemap:
+            for inst in self.assembled:
+                next_line = linemap[0]
+                del linemap[0]
+                while last_line < next_line:
+                    line = program_lines[last_line]
+                    if line:
+                        print(f"            // {line}")
+                    last_line += 1
+                line = program_lines[last_line]
+                print(f"    0x{inst:04x}, // {line}")
+                last_line += 1
+            while last_line < len(program_lines):
+                line = program_lines[last_line]
+                if line:
+                    print(f"            // {line}")
+                last_line += 1
+        else:
+            for i in range(0, len(self.assembled), 8):
+                print("    " + ", ".join("0x%04x" % i for i in self.assembled[i : i + 8]))
+        print("};")
+        print()
+
+
+def assemble(program_text: str) -> array.array:
+    """Converts pioasm text to encoded instruction bytes
+
+    In new code, prefer to use the `Program` class so that the extra arguments
+    such as the details about side-set pins can be easily passsed to the
+    ``StateMachine`` constructor."""
+    return Program(program_text).assembled

docs/api.rst

@@ -4,5 +4,8 @@
 .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
 .. use this format as the module name: "adafruit_foo.foo"
 
+API Reference
+#############
+
 .. automodule:: adafruit_pioasm
    :members:

docs/conf.py

@@ -1,9 +1,8 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
 
@@ -16,6 +15,7 @@ sys.path.insert(0, os.path.abspath(".."))
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinxcontrib.jquery",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
     "sphinx.ext.todo",
@@ -29,8 +29,8 @@ extensions = [
 
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.4", None),
-    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+    "python": ("https://docs.python.org/3", None),
+    "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None),
 }
 
 # Show the docstring from both the class and its __init__() method.
@@ -46,7 +46,12 @@ master_doc = "index"
 
 # General information about the project.
 project = "Adafruit PIOASM Library"
-copyright = "2021 Scott Shawcroft"
+creation_year = "2021"
+current_year = str(datetime.datetime.now().year)
+year_duration = (
+    current_year if current_year == creation_year else creation_year + " - " + current_year
+)
+copyright = year_duration + " Scott Shawcroft"
 author = "Scott Shawcroft"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -63,7 +68,7 @@ release = "1.0"
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -101,19 +106,9 @@ napoleon_numpy_docstring = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+import sphinx_rtd_theme
 
-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 = ["."]
+html_theme = "sphinx_rtd_theme"
 
 # 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,

docs/index.rst

@@ -14,6 +14,12 @@ Table of Contents
 
     examples
 
+.. toctree::
+    :caption: Syntax
+    :maxdepth: 3
+
+    syntax
+
 .. toctree::
     :caption: API Reference
     :maxdepth: 3
@@ -24,6 +30,7 @@ Table of Contents
     :caption: Tutorials
 
     Getting Started with Raspberry Pi Pico and CircuitPython <https://learn.adafruit.com/getting-started-with-raspberry-pi-pico-circuitpython>
+    An Introduction to RP2040 PIO with CircuitPython <https://learn.adafruit.com/intro-to-rp2040-pio-with-circuitpython>
 
 .. toctree::
     :caption: Related Products
@@ -36,8 +43,10 @@ Table of Contents
 .. toctree::
     :caption: Other Links
 
-    Download <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/releases/latest>
-    CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
+    Download from GitHub <https://github.com/adafruit/Adafruit_CircuitPython_PIOASM/releases/latest>
+    Download Library Bundle <https://circuitpython.org/libraries>
+    CircuitPython Reference Documentation <https://docs.circuitpython.org>
+    CircuitPython rp2pio Reference Documentation <https://docs.circuitpython.org/en/latest/shared-bindings/rp2pio>
     CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
     Discord Chat <https://adafru.it/discord>
     Adafruit Learning System <https://learn.adafruit.com>

docs/requirements.txt

@@ -0,0 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+sphinx
+sphinxcontrib-jquery
+sphinx-rtd-theme

docs/syntax.rst

@@ -0,0 +1,88 @@
+This chapter documents the language features accepted by the `adafruit_pioasm`
+assembler. The dialect is intended to be a compatible subset of the one in the
+pico-sdk's ``pioasm`` program (which does not produce CircuitPython-compatible
+output).
+
+For full details, refer to the relevant chapter in the RP2040 or RP2350 datasheet.
+
+In this informal grammar, ``<angle brackets>`` represent some text, usually a single
+word or number. ``{curly brackets}`` represent an element that is optional.
+``|`` represents alternatives. ``...`` indicates further arguments that are
+explained in the official datasheet.
+
+Lines
+~~~~~
+
+First, any portion of the line starting with the comment character ``;`` is removed.
+Then, extra whitespace is removed and the line is parsed.
+
+Each line may be:
+ * blank
+ * a directive
+ * a label
+ * an instruction, possibly with side-set and delay information
+
+Directives
+----------
+
+ * ``.program <identifier>``: Accepts a program name, which should be a valid Python identifier
+ * ``.pio_version <number>``: The numeric version of the PIO peripheral to target. Version 0, the default, is in the RP2040. Version 1 is in RP2350
+ * ``.origin <number>``: The required load address of the program. If specified and not ``-1``, this will be stored in ``pio_kwargs["offset"]``
+ * ``.wrap``, ``.wrap_target``: This pair of directives set the range of instructions for implicit looping, by placing values in ``pio_kwargs``
+ * ``.side_set <number> {opt}``: Controls the side-set behavior and sets ``pio_kwargs["sideset_enable"]`` and ``pio_kwargs["sideset_pin_count"]``
+ * ``.fifo <identifier>``: Sets the FIFO mode. As a CircuitPython extension, ``auto`` (the default) automatically chooses among ``txrx``, ``tx``, and ``rx`` modes
+ * ``.mov_status ...``: Controls what information the ``mov status`` instruction accesses, by placing values in ``pio_kwargs``
+ * ``.out <count> {{left|right}} {{auto}}``: Settings that control how the ``out`` instruction works, including shift direction and whether auto pull is enabled, by placing values in ``pio_kwargs``
+ * ``.in <count> {{left|right}} {{auto}}``: Settings that control how the ``in`` instruction works, including shift direction and whether auto push is enabled, by placing values in ``pio_kwargs``
+ * ``.set <count>``: Settings that control how the ``set`` instruction works, including shift direction and whether auto push is enabled, by placing values in ``pio_kwargs``
+
+Labels
+------
+
+ * ``<identifier>:`` creates a label which may be referred to by a ``jmp`` instruction.
+
+Instructions
+------------
+
+ * ``nop``
+ * ``jmp <number|name>``
+ * ``wait ...``
+ * ``in ...``
+ * ``out ...``
+ * ``push ...``
+ * ``pull ...``
+ * ``mov ...``
+ * ``mov rxfifo[y|number], isr`` (requires PIO version 1 and compatible ``.fifo`` setting)
+ * ``mov osr, rxfifo[y|number]`` (requires PIO version 1 and compatible ``.fifo`` setting)
+ * ``irq <number> {rel}``
+ * ``irq next|prev <number>``. (requires PIO version 1) adafruit_pioasm follows sdk pioasm in placing ``next`` and ``prev`` before the IRQ number. The datasheet (version 05c4754) implies a different syntax.
+ * ``set ...``
+
+Side-set and delay
+------------------
+The next part of each line can contain "side-set" and "delay" information, in order.
+
+ * ``side <number>``: Set the side-set pins to ``number``
+ * ``[<number>]``: Add ``number`` extra delay cycles to this instruction
+
+The range of these numbers depends on the count of side-set pins and whether side-set is
+optional. If side-set is not optional, a missing ``side <number>`` is treated the same as
+``side 0``.
+
+Unsupported Features
+--------------------
+
+In places where a numeric value is needed, only a valid Python numeric literal
+is accepted. Arithmetic is not supported.
+
+Whitespace is not accepted in certain places, for instance within an instruction delay.
+It must be written ``[7]`` not ``[ 7 ]``.
+
+Extra commas that would not be acceptable to sdk pioasm are not always diagnosed.
+
+Extra words in some locations that would not be acceptable to sdk pioasm are not always diagnosed.
+
+CircuitPython extensions
+------------------------
+
+* ``.fifo auto``: By default, CircuitPython joins the TX and RX fifos if a PIO program only receives or transmits. The ``.fifo auto`` directive makes this explicit.

docs/syntax.rst.license

@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
+
+SPDX-License-Identifier: MIT

examples/getting-started/README.md

@@ -1,7 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2020 Jeff Epler, written for Adafruit Industries
-
-SPDX-License-Identifier: MIT
--->
-
-These examples are adapted from [Getting started with MicroPython on the Raspberry Pi Pico](https://www.adafruit.com/product/4898).  You can also get an [electonic copy](https://hackspace.raspberrypi.org/books/micropython-pico/).  PIO is covered in Appendix C.

examples/pico-examples/README.md

@@ -1,7 +0,0 @@
-<!--
-SPDX-FileCopyrightText: 2020 Jeff Epler, written for Adafruit Industries
-
-SPDX-License-Identifier: MIT
--->
-
-These examples are adapted from the pio folder of the [Raspberry Pi Pico SDK Examples](https://github.com/raspberrypi/pico-examples).

examples/pioasm_7seg.py

@@ -0,0 +1,164 @@
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""Drive a 7-segment display entirely from the PIO peripheral
+
+By updating the buffer being written to the display, the shown digits can be changed.
+
+The main program just counts up, looping back to 0000 after 9999.
+
+This example is designed for a Raspberry Pi Pico and bare LED display. For
+simplicity, it is wired without any current limiting resistors, instead relying
+on a combination of the RP2040's pin drive strength and the 1/4 duty cycle to
+limit LED current to an acceptable level, and longevity of the display was not
+a priority.
+
+Before integrating a variant of this example code in a project, evaluate
+whether your design needs to add current-limiting resistors.
+
+https://www.adafruit.com/product/4864
+https://www.adafruit.com/product/865
+
+Wiring:
+ * Pico GP15 to LED matrix 1 (E SEG)
+ * Pico GP14 to LED matrix 2 (D SEG)
+ * Pico GP13 to LED matrix 3 (DP SEG)
+ * Pico GP12 to LED matrix 4 (C SEG)
+ * Pico GP11 to LED matrix 5 (G SEG)
+ * Pico GP10 to LED matrix 6 (COM4)
+ * Pico GP9 to LED matrix 7 (COLON COM)
+ * Pico GP22 to LED matrix 8 (COLON SEG)
+ * Pico GP21 to LED matrix 9 (B SEG)
+ * Pico GP20 to LED matrix 10 (COM3)
+ * Pico GP19 to LED matrix 11 (COM2)
+ * Pico GP18 to LED matrix 12 (F SEG)
+ * Pico GP17 to LED matrix 13 (A SEG)
+ * Pico GP16 to LED matrix 14 (COM1)
+"""
+
+import array
+import time
+
+import board
+import rp2pio
+
+import adafruit_pioasm
+
+_program = adafruit_pioasm.Program(
+    """
+    out pins, 14       ; set the pins to their new state
+    """
+)
+
+# Display Pins 1-7 are GP 15-9
+# Display Pins 8-12 are GP 22-16
+COM1_WT = 1 << 7
+COM2_WT = 1 << 10
+COM3_WT = 1 << 11
+COM4_WT = 1 << 1
+COMC_WT = 1 << 0
+
+SEGA_WT = 1 << 8
+SEGB_WT = 1 << 12
+SEGC_WT = 1 << 3
+SEGD_WT = 1 << 5
+SEGE_WT = 1 << 6
+SEGF_WT = 1 << 9
+SEGG_WT = 1 << 2
+
+SEGDP_WT = 1 << 4
+SEGCOL_WT = 1 << 13
+
+ALL_COM = COM1_WT | COM2_WT | COM3_WT | COM4_WT | COMC_WT
+
+SEG_WT = [
+    SEGA_WT,
+    SEGB_WT,
+    SEGC_WT,
+    SEGD_WT,
+    SEGE_WT,
+    SEGF_WT,
+    SEGG_WT,
+    SEGDP_WT,
+    SEGCOL_WT,
+]
+COM_WT = [COM1_WT, COM2_WT, COM3_WT, COM4_WT, COMC_WT]
+
+DIGITS = [
+    0b0111111,  # 0
+    0b0000110,  # 1
+    0b1011011,  # 2
+    0b1001111,  # 3
+    0b1100110,  # 4
+    0b1101101,  # 5
+    0b1111100,  # 6
+    0b0000111,  # 7
+    0b1111111,  # 8
+    0b1101111,  # 9
+]
+
+
+def make_digit_wt(v):
+    val = ALL_COM
+    seg = DIGITS[v]
+    for i in range(8):
+        if seg & (1 << i):
+            val |= SEG_WT[i]
+    return val
+
+
+DIGITS_WT = [make_digit_wt(i) for i in range(10)]
+
+
+class SMSevenSegment:
+    def __init__(self, first_pin=board.GP9):
+        self._buf = array.array("H", (DIGITS_WT[0] & ~COM_WT[i] for i in range(4)))
+        self._sm = rp2pio.StateMachine(
+            _program.assembled,
+            frequency=4000,
+            first_out_pin=first_pin,
+            out_pin_count=14,
+            auto_pull=True,
+            pull_threshold=14,
+            **_program.pio_kwargs,
+        )
+        self._sm.background_write(loop=self._buf)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.deinit()
+
+    def deinit(self):
+        self._sm.deinit()
+
+    def __setitem__(self, i, v):
+        if v is None:
+            self._buf[i] = 0
+        else:
+            self._buf[i] = DIGITS_WT[v] & ~COM_WT[i]
+
+    def set_number(self, number):
+        for j in range(4):
+            self[3 - j] = number % 10
+            number //= 10
+
+
+def count(start=0):
+    val = start
+    while True:
+        yield val
+        val += 1
+
+
+def main():
+    with SMSevenSegment(board.GP9) as s:
+        for i in count():
+            s.set_number(i)
+            time.sleep(0.05)
+
+
+if __name__ == "__main__":
+    main()

examples/pioasm_7seg_fader.py

@@ -0,0 +1,249 @@
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""Drive a 7-segment display entirely from the PIO peripheral
+
+Each segment is driven with a 'breathing' waveform that runs at its own pace.
+It also demonstrates the use of `asyncio` to perform multiple tasks.
+
+This example is designed for a Raspberry Pi Pico and bare LED display. For
+simplicity, it is wired without any current limiting resistors, instead relying
+on a combination of the RP2040's pin drive strength and the 1/45 duty cycle to
+limit LED current to an acceptable level, and longevity of the display was not
+a priority.
+
+Before integrating a variant of this example code in a project, evaluate
+whether your design needs to add current-limiting resistors.
+
+https://www.adafruit.com/product/4864
+https://www.adafruit.com/product/865
+
+Wiring:
+ * Pico GP15 to LED matrix 1 (E SEG)
+ * Pico GP14 to LED matrix 2 (D SEG)
+ * Pico GP13 to LED matrix 3 (DP SEG)
+ * Pico GP12 to LED matrix 4 (C SEG)
+ * Pico GP11 to LED matrix 5 (G SEG)
+ * Pico GP10 to LED matrix 6 (COM4)
+ * Pico GP9 to LED matrix 7 (COLON COM)
+ * Pico GP22 to LED matrix 8 (COLON SEG)
+ * Pico GP21 to LED matrix 9 (B SEG)
+ * Pico GP20 to LED matrix 10 (COM3)
+ * Pico GP19 to LED matrix 11 (COM2)
+ * Pico GP18 to LED matrix 12 (F SEG)
+ * Pico GP17 to LED matrix 13 (A SEG)
+ * Pico GP16 to LED matrix 14 (COM1)
+"""
+
+import array
+import asyncio
+import random
+
+import board
+import rp2pio
+from ulab import numpy as np
+
+import adafruit_pioasm
+
+_pio_source = """
+    mov pins, null     ; turn all pins off
+    pull
+    out pindirs, {n}   ; set the new direction
+    pull
+    out pins, {n}      ; set the new values
+    pull
+    out y, 32
+delay:
+    jmp y--, delay
+    """
+
+# Display Pins 1-7 are GP 15-9 [need to re-wire 9]
+# Display Pins 8-12 are GP 22-16 [need to re-wire 22]
+# GP#       Display#    Function
+# 15 (+ 6)   1          E SEG
+# 14 (+ 5)   2          D SEG
+# 13 (+ 4)   3          DP SEG
+# 12 (+ 3)   4          C SEG
+# 11 (+ 2)   5          G SEG
+# 10 (+ 1)   6          COM4
+#  9 (+ 0)   7          COLON COM
+# 22 (+13)   8          COLON SEG
+# 21 (+12)   9          B SEG
+# 20 (+11)  10          COM3
+# 19 (+10)  11          COM2
+# 18 (+ 9)  12          F SEG
+# 17 (+ 8)  13          A SEG
+# 16 (+ 7)  14          COM1
+
+COM1_WT = 1 << 7
+COM2_WT = 1 << 10
+COM3_WT = 1 << 11
+COM4_WT = 1 << 1
+COMC_WT = 1 << 0
+
+SEGA_WT = 1 << 8
+SEGB_WT = 1 << 12
+SEGC_WT = 1 << 3
+SEGD_WT = 1 << 5
+SEGE_WT = 1 << 6
+SEGF_WT = 1 << 9
+SEGG_WT = 1 << 2
+
+SEGDP_WT = 1 << 4
+SEGCOL_WT = 1 << 13
+
+ALL_COM = COM1_WT | COM2_WT | COM3_WT | COM4_WT | COMC_WT
+
+SEG_WT = [
+    SEGA_WT,
+    SEGB_WT,
+    SEGC_WT,
+    SEGD_WT,
+    SEGE_WT,
+    SEGF_WT,
+    SEGG_WT,
+    SEGDP_WT,
+    SEGCOL_WT,
+]
+COM_WT = [COM1_WT, COM2_WT, COM3_WT, COM4_WT, COMC_WT]
+
+DIGITS = [
+    0b0111111,  # 0
+    0b0000110,  # 1
+    0b1011011,  # 2
+    0b1001111,  # 3
+    0b1100110,  # 4
+    0b1101101,  # 5
+    0b1111100,  # 6
+    0b0000111,  # 7
+    0b1111111,  # 8
+    0b1101111,  # 9
+]
+
+
+def make_digit_wt(v):
+    val = ALL_COM
+    seg = DIGITS[v]
+    for i in range(8):
+        if seg & (1 << i):
+            val |= SEG_WT[i]
+    return val
+
+
+class LedFader:
+    def __init__(self, first_pin, pin_count, cathode_weights, anode_weights, levels=64):
+        self._cathode_weights = cathode_weights
+        self._anode_weights = anode_weights
+        self._stream = array.array("L", [0, 0, 1]) * (1 + len(cathode_weights) * len(anode_weights))
+        self._levels = levels
+        self._max_count = levels * len(self)
+        self._total = len(self)
+
+        program = adafruit_pioasm.Program(_pio_source.format(n=pin_count))
+        self._sm = rp2pio.StateMachine(
+            program.assembled,
+            frequency=125_000_000,
+            first_out_pin=first_pin,
+            out_pin_count=14,
+            auto_pull=True,
+            pull_threshold=14,
+            **program.pio_kwargs,
+        )
+        print(f"Note: approximate refresh rate {self._sm.frequency / self._max_count:.0f}Hz")
+        self._sm.background_write(loop=self._stream)
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.deinit()
+
+    def deinit(self):
+        self._sm.deinit()
+
+    def __setitem__(self, i, v):
+        if not 0 <= v < self._levels:
+            raise ValueError()
+
+        c = i % len(self._cathode_weights)
+        r = i // len(self._cathode_weights)
+        if not v:
+            self._total = self._total - self._stream[3 * i + 2] + 1
+            self._stream[3 * i] = 0
+            self._stream[3 * i + 1] = 0
+            self._stream[3 * i + 2] = 1
+        else:
+            self._total = self._total - self._stream[3 * i + 2] + v
+            self._stream[3 * i] = self._cathode_weights[c] | self._anode_weights[r]
+            self._stream[3 * i + 1] = self._cathode_weights[c]
+            self._stream[3 * i + 2] = v
+        self._stream[3 * len(self) + 2] = self._max_count - self._total
+
+    def __len__(self):
+        return len(self._stream) // 3 - 1
+
+
+class CyclicSignal:
+    def __init__(self, data, phase=0):
+        self._data = data
+        self._phase = 0
+        self.phase = phase
+        self._scale = len(self._data) - 1
+
+    @property
+    def phase(self):
+        return self._phase
+
+    @phase.setter
+    def phase(self, value):
+        self._phase = value % 1
+
+    @property
+    def value(self):
+        idxf = self._phase * len(self._data)
+        idx = int(idxf)
+        frac = idxf % 1
+        idx1 = (idx + 1) % len(self._data)
+        val = self._data[idx]
+        val1 = self._data[idx1]
+        return val + (val1 - val) * frac
+
+    def advance(self, delta):
+        self._phase = (self._phase + delta) % 1
+
+
+sine = (np.sin(np.linspace(0, 2 * np.pi, 50, endpoint=False)) * 0.5 + 0.5) ** 2.2 * 64
+
+
+async def segment_throbber(c, i):
+    signal = CyclicSignal(sine, random.random())
+    velocity = random.random() * 0.04 + 0.005
+
+    while True:
+        signal.advance(velocity)
+        c[i] = int(signal.value)
+        await asyncio.sleep(0)
+
+
+async def main():
+    with LedFader(
+        board.GP9,
+        14,
+        (
+            SEGA_WT,
+            SEGB_WT,
+            SEGC_WT,
+            SEGD_WT,
+            SEGE_WT,
+            SEGF_WT,
+            SEGG_WT,
+            SEGDP_WT,
+            SEGCOL_WT,
+        ),
+        (COM1_WT, COM2_WT, COM3_WT, COM4_WT, COMC_WT),
+    ) as c:
+        await asyncio.gather(*(segment_throbber(c, i) for i in range(len(c))))
+
+
+asyncio.run(main())

examples/pioasm_background_morse.py

@@ -0,0 +1,100 @@
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""Demonstrate background writing, including loop writing, with morse code.
+
+On any rp2040 board with board.LED, this will alternately send 'SOS' and 'TEST'
+via the LED, demonstrating that Python code continues to run while the morse
+code data is transmitted. Alternately, change one line below to make it send
+'TEST' forever in a loop, again while Python code continues to run.
+
+The combination of "LED status" and duration is sent to the PIO as 16-bit number:
+The top bit is 1 if the LED is turned on and 0 otherwise.  The other 15 bits form a delay
+value from 1 to 32767. A subset of the morse code 'alphabit' is created, with everthing
+based on the 'DIT duration' of about 128ms (1MHz / 32 / 4000).
+
+https://en.wikipedia.org/wiki/Morse_code
+"""
+
+import array
+import time
+
+from board import LED
+from rp2pio import StateMachine
+
+from adafruit_pioasm import Program
+
+# This program turns the LED on or off depending on the first bit of the value,
+# then delays a length of time given by the next 15 bits of the value.
+# By correctly choosing the durations, a message in morse code can be sent.
+pio_code = Program(
+    """
+        out x, 1
+        mov pins, x
+        out x, 15
+    busy_wait:
+        jmp x--, busy_wait [31]
+        """
+)
+
+
+# The top bit of the command is the LED value, on or off
+LED_ON = 0x8000
+LED_OFF = 0x0000
+
+# The other 15 bits are a delay duration.
+# It must be the case that 4 * DIT_DURATION < 32768
+DIT_DURATION = 4000
+DAH_DURATION = 3 * DIT_DURATION
+
+# Build up some elements of morse code, based on the wikipedia article.
+DIT = array.array("H", [LED_ON | DIT_DURATION, LED_OFF | DIT_DURATION])
+DAH = array.array("H", [LED_ON | DAH_DURATION, LED_OFF | DIT_DURATION])
+# That is, two more DAH-length gaps for a total of three
+LETTER_SPACE = array.array("H", [LED_OFF | (2 * DAH_DURATION)])
+# That is, four more DAH-length gaps (after a letter space) for a total of seven
+WORD_SPACE = array.array("H", [LED_OFF | (4 * DIT_DURATION)])
+
+# Letters and words can be created by concatenating ("+") the elements
+E = DIT + LETTER_SPACE
+O = DAH + DAH + DAH + LETTER_SPACE
+S = DIT + DIT + DIT + LETTER_SPACE
+T = DAH + LETTER_SPACE
+SOS = S + O + S + WORD_SPACE
+TEST = T + E + S + T + WORD_SPACE
+
+sm = StateMachine(
+    pio_code.assembled,
+    frequency=1_000_000,
+    first_out_pin=LED,
+    pull_threshold=16,
+    auto_pull=True,
+    out_shift_right=False,
+    **pio_code.pio_kwargs,
+)
+
+# To simply repeat 'TEST' forever, change to 'if True':
+if False:
+    print("Sending out TEST forever", end="")
+    sm.background_write(loop=TEST)
+    while True:
+        print(end=".")
+        time.sleep(0.1)
+
+# But instead, let's alternate SOS and TEST, forever:
+
+while True:
+    for plain, morse in (
+        ("SOS", SOS),
+        ("TEST", TEST),
+    ):
+        print(f"Sending out {plain}", end="")
+        sm.background_write(morse)
+        sm.clear_txstall()
+        while not sm.txstall:
+            print(end=".")
+            time.sleep(0.1)
+        print()
+        print("Message all sent to StateMachine (including emptying FIFO)")
+        print()

examples/pioasm_blink.py

@@ -6,8 +6,10 @@
 
 import array
 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm
 
 blink = adafruit_pioasm.assemble(

examples/pioasm_hello.py

@@ -5,8 +5,10 @@
 # Adapted from the example https://github.com/raspberrypi/pico-examples/tree/master/pio/hello_pio
 
 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm
 
 hello = """
@@ -25,7 +27,7 @@ assembled = adafruit_pioasm.assemble(hello)
 
 sm = rp2pio.StateMachine(
     assembled,
-    frequency=2000,
+    frequency=4000,
     first_out_pin=board.LED,
 )
 print("real frequency", sm.frequency)

examples/pioasm_i2s_codec.py

@@ -0,0 +1,211 @@
+# SPDX-FileCopyrightText: 2024 Tim Chinowsky
+# SPDX-License-Identifier: MIT
+
+import array
+
+import board
+import rp2pio
+
+import adafruit_pioasm
+
+# Implement extended multichannel I2S interface like that used by audio codecs
+# such as the TAC5212.  In extended I2S, "Left" and "Right" can each contain
+# multiple channels, so for instance 8 channels of audio can be sent as a "left"
+# containing 4 channels and a "right" containing 4 channels.
+
+# In this implementation the number of bits per sample, sample rate, and
+# number of channels can be independently specified.  The number of channels must
+# be even, to divide evenly between left and right.
+
+# Ramped test data containing the requested number of sample sets (one set = one
+# sample for each channel) and spanning the specified number of bits will be generated
+# and sent out over I2S on the specified pins.
+
+# Data will be preceded and followed by a set of zeros for convenience.
+# (Some protocol analyzers have trouble analyzing serial data at the the beginning
+# and end of a data set)
+
+# At the same time that I2S data is sent out the out_pin, I2S data will be received
+# on the in_pin.  If the output is looped back (connected) to the input, the data
+# received should be the same as the data sent.
+
+# Some samples run in loopback configuration:
+
+# bits per sample: 16
+#     sample rate: 48000
+#        channels: 4
+#     sample sets: 4
+
+# actual sample frequency   47984.6 Hz
+#               bit clock 3071017.0 Hz
+
+# write: 00000000  00000000  00000000  00000000
+#  read: 00000000  00000000  00000000  00000000
+
+# write: 00000000  00001111  00002222  00003333
+#  read: 00000000  00001111  00002222  00003333
+
+# write: 00004444  00005555  00006666  00007777
+#  read: 00004444  00005555  00006666  00007777
+
+# write: 00008888  00009999  0000aaaa  0000bbbb
+#  read: 00008888  00009999  0000aaaa  0000bbbb
+
+# write: 0000cccc  0000dddd  0000eeee  0000ffff
+#  read: 0000cccc  0000dddd  0000eeee  0000ffff
+
+# write: 00000000  00000000  00000000  00000000
+#  read: 00000000  00000000  00000000  00000000
+
+# bits per sample: 24
+#     sample rate: 24000
+#        channels: 8
+#     sample sets: 5
+
+# actual sample frequency   23987.7 Hz
+#               bit clock 4605642.0 Hz
+
+# write: 00000000  00000000  00000000  00000000  00000000  00000000  00000000  00000000
+#  read: 00000000  00000000  00000000  00000000  00000000  00000000  00000000  00000000
+
+# write: 00000000  00069069  000d20d2  0013b13b  001a41a4  0020d20d  00276276  002df2df
+#  read: 00000000  00069069  000d20d2  0013b13b  001a41a4  0020d20d  00276276  002df2df
+
+# write: 00348348  003b13b1  0041a41a  00483482  004ec4ec  00555554  005be5be  00627626
+#  read: 00348348  003b13b1  0041a41a  00483482  004ec4ec  00555554  005be5be  00627626
+
+# write: 00690690  006f96f8  00762762  007cb7ca  00834834  0089d89c  00906904  0096f96c
+#  read: 00690690  006f96f8  00762762  007cb7ca  00834834  0089d89c  00906904  0096f96c
+
+# write: 009d89d8  00a41a40  00aaaaa8  00b13b10  00b7cb7c  00be5be4  00c4ec4c  00cb7cb4
+#  read: 009d89d8  00a41a40  00aaaaa8  00b13b10  00b7cb7c  00be5be4  00c4ec4c  00cb7cb4
+
+# write: 00d20d20  00d89d88  00df2df0  00e5be58  00ec4ec4  00f2df2c  00f96f94  00ffffff
+#  read: 00d20d20  00d89d88  00df2df0  00e5be58  00ec4ec4  00f2df2c  00f96f94  00ffffff
+
+# write: 00000000  00000000  00000000  00000000  00000000  00000000  00000000  00000000
+#  read: 00000000  00000000  00000000  00000000  00000000  00000000  00000000  00000000
+
+
+def i2s_codec(
+    channels=2,
+    sample_rate=48000,
+    bits=16,
+    bclk_pin=None,
+    out_pin=None,
+    in_pin=None,
+):
+    i2s_clock = sample_rate * channels * bits
+    pio_clock = 4 * i2s_clock
+    pio_code = """
+        .program i2s_codec
+        .side_set 2
+                            ; at program start we initialize the bit count top
+                            ; (which may be >32) with data
+                            ; pulled from the input fifo
+            pull noblock    ; first empty the input fifo
+            pull noblock
+            pull noblock
+            pull noblock
+            out null, 32    ; then clear OSR so we can get a new value
+            pull block      ; then get the bit count top value from the fifo
+                            ;        /--- LRCLK
+                            ;        |/-- BCLK
+                            ;        ||
+            mov x, osr;       side 0b01 [1] ; save it in x
+            out null, 32      side 0b00 [1]
+            mov y, x          side 0b01 [1] ; start of main loop (wrap target=8)
+        bitloop1:
+            out pins 1        side 0b00
+            in pins 1         side 0b00
+            jmp y-- bitloop1  side 0b01 [1]
+            out pins 1        side 0b10
+            in pins 1         side 0b10
+            mov y, x          side 0b11 [1]
+        bitloop0:
+            out pins 1        side 0b10
+            in pins 1         side 0b10
+            jmp y-- bitloop0  side 0b11 [1]
+            out pins 1        side 0b00
+            in pins 1         side 0b00
+    """
+    pio_params = {
+        "frequency": pio_clock,
+        "first_out_pin": out_pin,
+        "first_in_pin": in_pin,
+        "first_sideset_pin": bclk_pin,
+        "sideset_pin_count": 2,
+        "auto_pull": True,
+        "auto_push": True,
+        "out_shift_right": False,
+        "in_shift_right": False,
+        "pull_threshold": bits,
+        "push_threshold": bits,
+        "wait_for_txstall": False,
+        "wrap_target": 8,
+    }
+    pio_instructions = adafruit_pioasm.assemble(pio_code)
+    i2s_clock = sample_rate * channels * bits
+    pio_clock = 4 * i2s_clock
+    pio = rp2pio.StateMachine(pio_instructions, **pio_params)
+    return pio
+
+
+def spaced_samples(length, bits):
+    max_int = (1 << bits) - 1
+    if length == 1:
+        return [0]
+    step = max_int / (length - 1)
+    result = [round(i * step) for i in range(length)]
+    result[0] = 0
+    result[-1] = max_int
+    return result
+
+
+while True:
+    print()
+    BITS = int(input("# bits per sample: "))
+    SAMPLE_RATE = int(input("#     sample rate: "))
+    CHANNELS = int(input("#        channels: "))
+    SAMPLE_SETS = int(input("#     sample sets: "))
+
+    n_samples = CHANNELS * SAMPLE_SETS
+    buffer_type = "L"
+    buffer_width = 32
+    data = [0] * CHANNELS + spaced_samples(n_samples, BITS) + [0] * CHANNELS
+    # initialize pio bit count top value by sending it at the start of output data
+    bit_count_top = BITS * (CHANNELS // 2) - 2
+    buffer_out = array.array(
+        buffer_type, [bit_count_top] + [d << (buffer_width - BITS) for d in data]
+    )
+    buffer_in = array.array(buffer_type, [0] * len(data))
+
+    PIO = i2s_codec(
+        channels=CHANNELS,
+        bits=BITS,
+        sample_rate=SAMPLE_RATE,
+        out_pin=board.D9,
+        in_pin=board.D10,
+        bclk_pin=board.D5,  # L/R signal will be one pin higher, i.e. D6
+    )
+    print()
+    print(f"# actual sample frequency {PIO.frequency/4/CHANNELS/BITS:9.1f} Hz")
+    print(f"#               bit clock {PIO.frequency/4:9.1f} Hz")
+    print()
+    PIO.write_readinto(buffer_out, buffer_in)
+    start = 0
+    line_length = CHANNELS
+
+    while start < len(buffer_in):
+        print("# write: ", end="")
+        for i in range(start, min(len(data), start + line_length)):
+            print(f"{data[i]:0{buffer_width/4}x} ", end=" ")
+        print()
+        print("#  read: ", end="")
+        for i in range(start, min(len(buffer_in), start + line_length)):
+            print(f"{buffer_in[i]:0{buffer_width/4}x} ", end=" ")
+        print()
+        print()
+        start += line_length
+    PIO.deinit()
+    del PIO

examples/pioasm_i2sout.py

@@ -5,9 +5,11 @@
 import array
 import math
 import time
+
 import board
 import digitalio
 import rp2pio
+
 import adafruit_pioasm
 
 trigger = digitalio.DigitalInOut(board.D4)
@@ -19,7 +21,7 @@ length = 8000 // 440
 # signed 16 bit
 s16 = array.array("h", [0] * length)
 for i in range(length):
-    s16[i] = int(math.sin(math.pi * 2 * i / length) * (2 ** 15))
+    s16[i] = int(math.sin(math.pi * 2 * i / length) * (2**15))
     print(s16[i])
 
 program = """

examples/pioasm_led_brightness.py

@@ -5,8 +5,10 @@
 # Adapted from the an example in Appendix C of RPi_PiPico_Digital_v10.pdf
 
 import time
+
 import board
 import rp2pio
+
 import adafruit_pioasm
 
 led_quarter_brightness = adafruit_pioasm.assemble(
@@ -30,20 +32,14 @@ led_full_brightness = adafruit_pioasm.assemble(
 )
 
 while True:
-    sm = rp2pio.StateMachine(
-        led_quarter_brightness, frequency=10000, first_set_pin=board.LED
-    )
+    sm = rp2pio.StateMachine(led_quarter_brightness, frequency=10000, first_set_pin=board.LED)
     time.sleep(1)
     sm.deinit()
 
-    sm = rp2pio.StateMachine(
-        led_half_brightness, frequency=10000, first_set_pin=board.LED
-    )
+    sm = rp2pio.StateMachine(led_half_brightness, frequency=10000, first_set_pin=board.LED)
     time.sleep(1)
     sm.deinit()
 
-    sm = rp2pio.StateMachine(
-        led_full_brightness, frequency=10000, first_set_pin=board.LED
-    )
+    sm = rp2pio.StateMachine(led_full_brightness, frequency=10000, first_set_pin=board.LED)
     time.sleep(1)
     sm.deinit()

examples/pioasm_neopixel.py

@@ -3,24 +3,29 @@
 # SPDX-License-Identifier: MIT
 
 import time
-import rp2pio
+
 import board
 import microcontroller
+import rp2pio
+
 import adafruit_pioasm
 
-# NeoPixels are 800khz bit streams. Zeroes are 1/3 duty cycle (~416ns) and ones
-# are 2/3 duty cycle (~833ns).
+# NeoPixels are 800khz bit streams. We are choosing zeros as <312ns hi, 936 lo>
+# and ones as <700 ns hi, 556 ns lo>.
+# The first two instructions always run while only one of the two final
+# instructions run per bit. We start with the low period because it can be
+# longer while waiting for more data.
 program = """
 .program ws2812
 .side_set 1
 .wrap_target
 bitloop:
-  out x 1        side 0 [1]; Side-set still takes place when instruction stalls
-  jmp !x do_zero side 1 [1]; Branch on the bit we shifted out. Positive pulse
-do_one:
-  jmp  bitloop   side 1 [1]; Continue driving high, for a long pulse
-do_zero:
-  nop            side 0 [1]; Or drive low, for a short pulse
+   out x 1        side 0 [6]; Drive low. Side-set still takes place before instruction stalls.
+   jmp !x do_zero side 1 [3]; Branch on the bit we shifted out previous delay. Drive high.
+ do_one:
+   jmp  bitloop   side 1 [4]; Continue driving high, for a one (long pulse)
+ do_zero:
+   nop            side 0 [4]; Or drive low, for a zero (short pulse)
 .wrap
 """
 
@@ -35,7 +40,7 @@ else:
 
 sm = rp2pio.StateMachine(
     assembled,
-    frequency=800000 * 6,  # 800khz * 6 clocks per bit
+    frequency=12_800_000,  # to get appropriate sub-bit times in PIO program
     first_sideset_pin=NEOPIXEL,
     auto_pull=True,
     out_shift_right=False,

examples/pioasm_neopixel_bg.py

@@ -0,0 +1,143 @@
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""Demonstrate background writing with NeoPixels
+
+The NeoPixelBackground class defined here is largely compatible with the
+standard NeoPixel class, except that the ``show()`` method returns immediately,
+writing data to the LEDs in the background, and setting `auto_write` to true
+causes the data to be continuously sent to the LEDs all the time.
+
+Writing the LED data in the background will allow more time for your
+Python code to run, so it may be possible to slightly increase the refresh
+rate of your LEDs or do more complicated processing.
+
+Because the pixelbuf storage is also being written out 'live', it is possible
+(even with auto-show 'false') to experience tearing, where the LEDs are a
+combination of old and new values at the same time.
+
+The demonstration code, under ``if __name__ == '__main__':`` is intended
+for the Adafruit MacroPad, with 12 NeoPixel LEDs. It shows a cycling rainbow
+pattern across all the LEDs.
+"""
+
+import struct
+
+import adafruit_pixelbuf
+from rp2pio import StateMachine
+
+from adafruit_pioasm import Program
+
+# Pixel color order constants
+RGB = "RGB"
+"""Red Green Blue"""
+GRB = "GRB"
+"""Green Red Blue"""
+RGBW = "RGBW"
+"""Red Green Blue White"""
+GRBW = "GRBW"
+"""Green Red Blue White"""
+
+# NeoPixels are 800khz bit streams. We are choosing zeros as <312ns hi, 936 lo>
+# and ones as <700 ns hi, 556 ns lo>.
+_program = Program(
+    """
+.side_set 1 opt
+.wrap_target
+    pull block          side 0
+    out y, 32           side 0      ; get count of NeoPixel bits
+
+bitloop:
+    pull ifempty        side 0      ; drive low
+    out x 1             side 0 [5]
+    jmp !x do_zero      side 1 [3]  ; drive high and branch depending on bit val
+    jmp y--, bitloop    side 1 [4]  ; drive high for a one (long pulse)
+    jmp end_sequence    side 0      ; sequence is over
+
+do_zero:
+    jmp y--, bitloop    side 0 [4]  ; drive low for a zero (short pulse)
+
+end_sequence:
+    pull block          side 0      ; get fresh delay value
+    out y, 32           side 0      ; get delay count
+wait_reset:
+    jmp y--, wait_reset side 0      ; wait until delay elapses
+.wrap
+        """
+)
+
+
+class NeoPixelBackground(adafruit_pixelbuf.PixelBuf):
+    def __init__(self, pin, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None):
+        if not pixel_order:
+            pixel_order = GRB if bpp == 3 else GRBW
+        elif isinstance(pixel_order, tuple):
+            order_list = [RGBW[order] for order in pixel_order]
+            pixel_order = "".join(order_list)
+
+        byte_count = bpp * n
+        bit_count = byte_count * 8
+        padding_count = -byte_count % 4
+
+        # backwards, so that dma byteswap corrects it!
+        header = struct.pack(">L", bit_count - 1)
+        trailer = b"\0" * padding_count + struct.pack(">L", 3840)
+
+        self._sm = StateMachine(
+            _program.assembled,
+            auto_pull=False,
+            first_sideset_pin=pin,
+            out_shift_right=False,
+            pull_threshold=32,
+            frequency=12_800_000,
+            **_program.pio_kwargs,
+        )
+
+        self._first = True
+        super().__init__(
+            n,
+            brightness=brightness,
+            byteorder=pixel_order,
+            auto_write=False,
+            header=header,
+            trailer=trailer,
+        )
+
+        self._auto_write = False
+        self._auto_writing = False
+        self.auto_write = auto_write
+
+    @property
+    def auto_write(self):
+        return self._auto_write
+
+    @auto_write.setter
+    def auto_write(self, value):
+        self._auto_write = bool(value)
+        if not value and self._auto_writing:
+            self._sm.background_write()
+            self._auto_writing = False
+        elif value:
+            self.show()
+
+    def _transmit(self, buf):
+        if self._auto_write:
+            if not self._auto_writing:
+                self._sm.background_write(loop=memoryview(buf).cast("L"), swap=True)
+                self._auto_writing = True
+        else:
+            self._sm.background_write(memoryview(buf).cast("L"), swap=True)
+
+
+if __name__ == "__main__":
+    import board
+    import rainbowio
+    import supervisor
+
+    NEOPIXEL = board.NEOPIXEL
+    NUM_PIXELS = 12
+    pixels = NeoPixelBackground(NEOPIXEL, NUM_PIXELS)
+    while True:
+        # Around 1 cycle per second
+        pixels.fill(rainbowio.colorwheel(supervisor.ticks_ms() // 4))

examples/pioasm_pdm.py

@@ -4,9 +4,11 @@
 
 import array
 import time
+
 import board
 import digitalio
 import rp2pio
+
 import adafruit_pioasm
 
 trigger = digitalio.DigitalInOut(board.D4)

examples/pioasm_print_c_program.py

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: 2021 Scott Shawcroft, written for Adafruit Industries
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import adafruit_pioasm
+
+# NeoPixels are 800khz bit streams. Zeroes are 1/3 duty cycle (~416ns) and ones
+# are 2/3 duty cycle (~833ns).
+text_program = """
+.program ws2812
+.side_set 1
+.wrap_target
+bitloop:
+  out x 1        side 0 [1]; Side-set still takes place when instruction stalls
+  jmp !x do_zero side 1 [1]; Branch on the bit we shifted out. Positive pulse
+do_one:
+  jmp  bitloop   side 1 [1]; Continue driving high, for a long pulse
+do_zero:
+  nop            side 0 [1]; Or drive low, for a short pulse
+.wrap
+"""
+
+program = adafruit_pioasm.Program(text_program, build_debuginfo=True)
+program.print_c_program("pio_ws2812", qualifier="static const")
+
+program = adafruit_pioasm.Program(text_program, build_debuginfo=False)
+program.print_c_program("pio_ws2812_short")

examples/pioasm_pulsegroup.py

@@ -0,0 +1,263 @@
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+#
+# Heavy inspiration from Pimoroni's "PWM Cluster":
+# https://github.com/pimoroni/pimoroni-pico/blob/main/drivers/pwm/pwm_cluster.cpp
+# https://github.com/pimoroni/pimoroni-pico/blob/main/drivers/pwm/pwm_cluster.pio
+
+import array
+
+import adafruit_ticks
+import board
+import rp2pio
+import ulab.numpy as np
+from adafruit_motor import servo
+
+import adafruit_pioasm
+
+_cycle_count = 3
+_program = adafruit_pioasm.Program(
+    """
+.wrap_target
+    out pins, 32            ; Immediately set the pins to their new state
+    out y, 32               ; Set the counter
+count_check:
+    jmp y-- delay           ; Check if the counter is 0, and if so wrap around.
+                            ; If not decrement the counter and jump to the delay
+.wrap
+
+delay:
+    jmp count_check [1]     ; Wait a few cycles then jump back to the loop
+"""
+)
+
+
+class PulseItem:
+    def __init__(self, group, index, phase, maxval):
+        self._group = group
+        self._index = index
+        self._phase = phase
+        self._value = 0
+        self._maxval = maxval
+        self._turn_on = self._turn_off = None
+        self._mask = 1 << index
+
+    @property
+    def frequency(self):
+        return self._group.frequency
+
+    @property
+    def duty_cycle(self):
+        return self._value
+
+    @duty_cycle.setter
+    def duty_cycle(self, value):
+        if value < 0 or value > self._maxval:
+            raise ValueError(f"value must be in the range(0, {self._maxval+1})")
+        self._value = value
+        self._recalculate()
+
+    @property
+    def phase(self):
+        return self._phase
+
+    @phase.setter
+    def phase(self, phase):
+        if phase < 0 or phase >= self._maxval:
+            raise ValueError(f"phase must be in the range(0, {self._maxval})")
+        self._phase = phase
+        self._recalculate()
+
+    def _recalculate(self):
+        self._turn_on = self._get_turn_on()
+        self._turn_off = self._get_turn_off()
+        self._group._maybe_update()
+
+    def _get_turn_on(self):
+        maxval = self._maxval
+        if self._value == 0:
+            return None
+        if self._value == self._maxval:
+            return 0
+        return self.phase % maxval
+
+    def _get_turn_off(self):
+        maxval = self._maxval
+        if self._value == 0:
+            return None
+        if self._value == self._maxval:
+            return None
+        return (self._value + self.phase) % maxval
+
+    def __str__(self):
+        return f"<PulseItem: {self.duty_cycle=} {self.phase=} {self._turn_on=} {self._turn_off=}>"
+
+
+class PulseGroup:
+    def __init__(
+        self,
+        first_pin,
+        pin_count,
+        period=0.02,
+        maxval=65535,
+        stagger=False,
+        auto_update=True,
+    ):
+        """Create a pulse group with the given characteristics"""
+        self._frequency = round(1 / period)
+        pio_frequency = round((1 + maxval) * _cycle_count / period)
+        self._sm = rp2pio.StateMachine(
+            _program.assembled,
+            frequency=pio_frequency,
+            first_out_pin=first_pin,
+            out_pin_count=pin_count,
+            auto_pull=True,
+            pull_threshold=32,
+            **_program.pio_kwargs,
+        )
+        self._auto_update = auto_update
+        self._items = [
+            PulseItem(self, i, round(maxval * i / pin_count) if stagger else 0, maxval)
+            for i in range(pin_count)
+        ]
+        self._maxval = maxval
+
+    @property
+    def frequency(self):
+        return self._frequency
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.deinit()
+
+    def deinit(self):
+        self._sm.deinit()
+        del self._items[:]
+
+    def __getitem__(self, i):
+        """Get an individual pulse generator"""
+        return self._items[i]
+
+    def __len__(self):
+        return len(self._items)
+
+    def update(self):
+        changes = {0: [0, 0]}
+
+        for i in self._items:
+            turn_on = i._turn_on
+            turn_off = i._turn_off
+            mask = i._mask
+
+            if turn_on is not None:
+                this_change = changes.get(turn_on)
+                if this_change:
+                    this_change[0] |= mask
+                else:
+                    changes[turn_on] = [mask, 0]
+
+                # start the cycle 'on'
+                if turn_off is not None and turn_off < turn_on:
+                    changes[0][0] |= mask
+
+            if turn_off is not None:
+                this_change = changes.get(turn_off)
+                if this_change:
+                    this_change[1] |= mask
+                else:
+                    changes[turn_off] = [0, mask]
+
+        def make_sequence():
+            sorted_changes = sorted(changes.items())
+            # Note that the first change time is always 0! Loop over range(len) is
+            # to reduce allocations
+            old_time = 0
+            value = 0
+            for time, (turn_on, turn_off) in sorted_changes:
+                if time != 0:  # never occurs on the first iteration
+                    yield time - old_time - 1
+                old_time = time
+
+                value = (value | turn_on) & ~turn_off
+                yield value
+
+            # the final delay value
+            yield self._maxval - old_time
+
+        buf = array.array("L", make_sequence())
+
+        self._sm.background_write(loop=buf)
+
+    def _maybe_update(self):
+        if self._auto_update:
+            self.update()
+
+    @property
+    def auto_update(self):
+        return self.auto_update
+
+    @auto_update.setter
+    def auto_update(self, value):
+        self.auto_update = bool(value)
+
+    def __str__(self):
+        return f"<PulseGroup({len(self)})>"
+
+
+class CyclicSignal:
+    def __init__(self, data, phase=0):
+        self._data = data
+        self._phase = 0
+        self.phase = phase
+        self._scale = len(self._data) - 1
+
+    @property
+    def phase(self):
+        return self._phase
+
+    @phase.setter
+    def phase(self, value):
+        self._phase = value % 1
+
+    @property
+    def value(self):
+        idxf = self._phase * len(self._data)
+        idx = int(idxf)
+        frac = idxf % 1
+        idx1 = (idx + 1) % len(self._data)
+        val = self._data[idx]
+        val1 = self._data[idx1]
+        return val + (val1 - val) * frac
+
+    def advance(self, delta):
+        self._phase = (self._phase + delta) % 1
+
+
+if __name__ == "__main__":
+    pulsers = PulseGroup(board.SERVO_1, 18, auto_update=False)
+    # Set the phase of each servo so that servo 0 starts at offset 0ms, servo 1
+    # at offset 2.5ms, ...
+    # For up to 8 servos, this means their duty cycles do not overlap.  Otherwise,
+    # servo 9 is also at offset 0ms, etc.
+    for j, p in enumerate(pulsers):
+        p.phase = 8192 * (j % 8)
+
+    servos = [servo.Servo(p) for p in pulsers]
+
+    sine = np.sin(np.linspace(0, 2 * np.pi, 50, endpoint=False)) * 0.5 + 0.5
+    print(sine)
+
+    signals = [CyclicSignal(sine, j / len(servos)) for j in range(len(servos))]
+
+    t0 = adafruit_ticks.ticks_ms()
+    while True:
+        t1 = adafruit_ticks.ticks_ms()
+        for servo, signal in zip(servos, signals):
+            signal.advance((t1 - t0) / 8000)
+            servo.fraction = signal.value
+        pulsers.update()
+        print(adafruit_ticks.ticks_diff(t1, t0), "ms")
+        t0 = t1

examples/pioasm_rotaryencoder.py

@@ -5,11 +5,12 @@
 # This example is adapted in part from micropython:
 # https://github.com/micropython/micropython/pull/6894/files
 
-import adafruit_pioasm
+import array
+
 import board
 import rp2pio
-import array
-import digitalio
+
+import adafruit_pioasm
 
 
 class IncrementalEncoder:
@@ -111,8 +112,6 @@ encoder = IncrementalEncoder(board.GP2, board.GP3)
 
 old_value = None
 while True:
-    gen()
-
     value = encoder.value
     if old_value != value:
         print("Encoder:", value)

examples/pioasm_rp2350_fifo.py

@@ -0,0 +1,86 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""A PIO demo that uses the FIFO in random access mode
+
+Random access mode is a new feature of the PIO peripheral of the RP2350.
+This demo is not compatible with the original RP2040 or Raspberry Pi
+Pico.
+
+Wiring:
+ * LED with current limiting resistor on GP25 (Pico 2 standard location)
+
+The LED will blink in several patterns depending on the values loaded in the 'rxfifo' registers
+"""
+
+import array
+import time
+
+import board
+import rp2pio
+
+import adafruit_pioasm
+
+program = adafruit_pioasm.Program(
+    """
+    .pio_version 1
+    .set 1
+    .fifo txget
+
+    ; LED on time taken from rxfifo[0]
+    mov osr, rxfifo[0]
+    mov x, osr
+
+    set pins, 1
+xloop1:
+    jmp x--, xloop1
+
+    ; LED off time taken from rxfifo[1]
+    mov osr, rxfifo[1]
+    mov x, osr
+
+    set pins, 0
+xloop2:
+    jmp x--, xloop2
+    """
+)
+
+
+def assign_uint32s(ar, off, *args):
+    """Assign multiple 32-bit registers within an AddressRange"""
+    vv = b"".join(v.to_bytes(4, "little") for v in args)
+    ar[off : off + 4 * len(args)] = vv
+
+
+print(program.pio_kwargs)
+sm = rp2pio.StateMachine(
+    program.assembled,
+    first_set_pin=board.GP25,
+    frequency=10_000_000,
+    **program.pio_kwargs,
+)
+fifo = sm.rxfifo
+
+# Set non-zero register entries & re-start the state machine at its offset.
+# this is needed because the default register value could represent a very long delay
+fifo[0:4] = b"\1\0\0\0"
+fifo[4:8] = b"\1\0\0\0"
+sm.run(array.array("H", [sm.offset]))
+
+while True:
+    # equal blinks
+    assign_uint32s(fifo, 0, 2000000, 2000000)
+    time.sleep(1)
+
+    # small on time
+    assign_uint32s(fifo, 0, 1000000, 3000000)
+    time.sleep(1)
+
+    # small off time
+    assign_uint32s(fifo, 0, 3000000, 1000000)
+    time.sleep(1)
+
+    # slower blinks
+    assign_uint32s(fifo, 0, 3000000, 3000000)
+    time.sleep(1)

examples/pioasm_rxuart.py

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: MIT
 
 import rp2pio
+
 import adafruit_pioasm
 
 code = adafruit_pioasm.assemble(

examples/pioasm_simpletest.py

@@ -3,8 +3,10 @@
 # SPDX-License-Identifier: MIT
 
 import time
-import rp2pio
+
 import board
+import rp2pio
+
 import adafruit_pioasm
 
 squarewave = """

examples/pioasm_txuart.py

@@ -0,0 +1,54 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import rp2pio
+
+import adafruit_pioasm
+
+code = adafruit_pioasm.Program(
+    """
+.program uart_tx
+.side_set 1 opt
+
+; An 8n1 UART transmit program.
+; OUT pin 0 and side-set pin 0 are both mapped to UART TX pin.
+
+  pull side 1 [7] ; Assert stop bit, or stall with line in idle state
+  set x, 7 side 0 [7] ; Preload bit counter, assert start bit for 8 clocks
+bitloop: ; This loop will run 8 times (8n1 UART)
+  out pins, 1 ; Shift 1 bit from OSR to the first OUT pin
+  jmp x-- bitloop [6] ; Each loop iteration is 8 cycles.
+
+"""
+)
+
+
+class TXUART:
+    def __init__(self, *, tx, baudrate=9600):
+        self.pio = rp2pio.StateMachine(
+            code.assembled,
+            first_out_pin=tx,
+            first_sideset_pin=tx,
+            frequency=8 * baudrate,
+            initial_sideset_pin_state=1,
+            initial_sideset_pin_direction=1,
+            initial_out_pin_state=1,
+            initial_out_pin_direction=1,
+            **code.pio_kwargs,
+        )
+
+    @property
+    def timeout(self):
+        return 0
+
+    @property
+    def baudrate(self):
+        return self.pio.frequency // 8
+
+    @baudrate.setter
+    def baudrate(self, frequency):
+        self.pio.frequency = frequency * 8
+
+    def write(self, buf):
+        return self.pio.write(buf)

examples/pioasm_wrap.py

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: 2022 Jeff Epler, written for Adafruit Industries
+# SPDF-FileCopyrightText: 2020 Raspberry Pi (Trading) Ltd.
+#
+# SPDX-License-Identifier: BSD-3-Clause
+import adafruit_pioasm
+
+program = adafruit_pioasm.Program(
+    """
+    set pindirs, 1
+.wrap_target
+    set pins, 0
+    set pins, 1
+.wrap""",
+    build_debuginfo=True,
+)
+
+program.print_c_program("test")

optional_requirements.txt

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense

pyproject.toml

@@ -1,6 +1,45 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
+# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries
 #
-# SPDX-License-Identifier: Unlicense
+# SPDX-License-Identifier: MIT
 
-[tool.black]
-target-version = ['py35']
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "setuptools-scm",
+]
+
+[project]
+name = "adafruit-circuitpython-pioasm"
+description = "Simple assembler to convert pioasm to bytes"
+version = "0.0.0+auto.0"
+readme = "README.rst"
+authors = [
+    {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}
+]
+urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_PIOASM"}
+keywords = [
+    "adafruit",
+    "blinka",
+    "circuitpython",
+    "micropython",
+    "pioasm",
+    "rp2040",
+]
+license = {text = "MIT"}
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: System :: Hardware",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+]
+dynamic = ["dependencies", "optional-dependencies"]
+
+[tool.setuptools]
+py-modules = ["adafruit_pioasm"]
+
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies = {optional = {file = ["optional_requirements.txt"]}}

requirements.txt

@@ -1,6 +1,5 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-# SPDX-FileCopyrightText: Copyright (c) 2021 Scott Shawcroft for Adafruit Industries LLC
+# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries
 #
-# SPDX-License-Identifier: MIT
+# SPDX-License-Identifier: Unlicense
 
 Adafruit-Blinka

ruff.toml

@@ -0,0 +1,112 @@
+# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+target-version = "py38"
+line-length = 100
+
+[lint]
+preview = true
+select = ["I", "PL", "UP"]
+
+extend-select = [
+  "D419",  # empty-docstring
+  "E501",  # line-too-long
+  "W291",  # trailing-whitespace
+  "PLC0414",  # useless-import-alias
+  "PLC2401",  # non-ascii-name
+  "PLC2801",  # unnecessary-dunder-call
+  "PLC3002",  # unnecessary-direct-lambda-call
+  "E999",  # syntax-error
+  "PLE0101",  # return-in-init
+  "F706",  # return-outside-function
+  "F704",  # yield-outside-function
+  "PLE0116",  # continue-in-finally
+  "PLE0117",  # nonlocal-without-binding
+  "PLE0241",  # duplicate-bases
+  "PLE0302",  # unexpected-special-method-signature
+  "PLE0604",  # invalid-all-object
+  "PLE0605",  # invalid-all-format
+  "PLE0643",  # potential-index-error
+  "PLE0704",  # misplaced-bare-raise
+  "PLE1141",  # dict-iter-missing-items
+  "PLE1142",  # await-outside-async
+  "PLE1205",  # logging-too-many-args
+  "PLE1206",  # logging-too-few-args
+  "PLE1307",  # bad-string-format-type
+  "PLE1310",  # bad-str-strip-call
+  "PLE1507",  # invalid-envvar-value
+  "PLE2502",  # bidirectional-unicode
+  "PLE2510",  # invalid-character-backspace
+  "PLE2512",  # invalid-character-sub
+  "PLE2513",  # invalid-character-esc
+  "PLE2514",  # invalid-character-nul
+  "PLE2515",  # invalid-character-zero-width-space
+  "PLR0124",  # comparison-with-itself
+  "PLR0202",  # no-classmethod-decorator
+  "PLR0203",  # no-staticmethod-decorator
+  "UP004",  # useless-object-inheritance
+  "PLR0206",  # property-with-parameters
+  "PLR0904",  # too-many-public-methods
+  "PLR0911",  # too-many-return-statements
+  "PLR0912",  # too-many-branches
+  "PLR0913",  # too-many-arguments
+  "PLR0914",  # too-many-locals
+  "PLR0915",  # too-many-statements
+  "PLR0916",  # too-many-boolean-expressions
+  "PLR1702",  # too-many-nested-blocks
+  "PLR1704",  # redefined-argument-from-local
+  "PLR1711",  # useless-return
+  "C416",  # unnecessary-comprehension
+  "PLR1733",  # unnecessary-dict-index-lookup
+  "PLR1736",  # unnecessary-list-index-lookup
+
+  # ruff reports this rule is unstable
+  #"PLR6301",  # no-self-use
+
+  "PLW0108",  # unnecessary-lambda
+  "PLW0120",  # useless-else-on-loop
+  "PLW0127",  # self-assigning-variable
+  "PLW0129",  # assert-on-string-literal
+  "B033",  # duplicate-value
+  "PLW0131",  # named-expr-without-context
+  "PLW0245",  # super-without-brackets
+  "PLW0406",  # import-self
+  "PLW0602",  # global-variable-not-assigned
+  "PLW0603",  # global-statement
+  "PLW0604",  # global-at-module-level
+
+  # fails on the try: import typing used by libraries
+  #"F401",  # unused-import
+
+  "F841",  # unused-variable
+  "E722",  # bare-except
+  "PLW0711",  # binary-op-exception
+  "PLW1501",  # bad-open-mode
+  "PLW1508",  # invalid-envvar-default
+  "PLW1509",  # subprocess-popen-preexec-fn
+  "PLW2101",  # useless-with-lock
+  "PLW3301",  # nested-min-max
+]
+
+ignore = [
+    "PLR2004", # magic-value-comparison
+    "UP030", # format literals
+    "PLW1514",  # unspecified-encoding
+    "PLR0913", # too-many-arguments
+    "PLR0915", # too-many-statements
+    "PLR0917", # too-many-positional-arguments
+    "PLR0904", # too-many-public-methods
+    "PLR0912", # too-many-branches
+    "PLR0916", # too-many-boolean-expressions
+    "PLR6301", # could-be-static no-self-use
+    "PLC0415", # import outside toplevel
+    "PLC2701", # private import
+    "PLW2901", # loop var overwrite
+    "PLR1702", # too many nested blocks
+    "PLR1714", # multiple comparisons
+    "PLR0914", # too many local vars
+]
+
+[format]
+line-ending = "lf"

setup.py

@@ -1,60 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
-# SPDX-FileCopyrightText: Copyright (c) 2021 Scott Shawcroft for Adafruit Industries LLC
-#
-# SPDX-License-Identifier: MIT
-
-"""A setuptools based setup module.
-
-See:
-https://packaging.python.org/en/latest/distributing.html
-https://github.com/pypa/sampleproject
-"""
-
-from setuptools import setup, find_packages
-
-# To use a consistent encoding
-from codecs import open
-from os import path
-
-here = path.abspath(path.dirname(__file__))
-
-# Get the long description from the README file
-with open(path.join(here, "README.rst"), encoding="utf-8") as f:
-    long_description = f.read()
-
-setup(
-    name="adafruit-circuitpython-pioasm",
-    use_scm_version=True,
-    setup_requires=["setuptools_scm"],
-    description="Simple assembler to convert pioasm to bytes",
-    long_description=long_description,
-    long_description_content_type="text/x-rst",
-    # The project's main homepage.
-    url="https://github.com/adafruit/Adafruit_CircuitPython_PIOASM",
-    # Author details
-    author="Adafruit Industries",
-    author_email="circuitpython@adafruit.com",
-    install_requires=[
-        "Adafruit-Blinka",
-    ],
-    # Choose your license
-    license="MIT",
-    # See https://pypi.python.org/pypi?%3Aaction=list_classifiers
-    classifiers=[
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "Topic :: Software Development :: Libraries",
-        "Topic :: System :: Hardware",
-        "License :: OSI Approved :: MIT License",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.4",
-        "Programming Language :: Python :: 3.5",
-    ],
-    # What does your project relate to?
-    keywords="adafruit blinka circuitpython micropython pioasm rp2040",
-    # You can just specify the packages manually here if your project is
-    # simple. Or you can use find_packages().
-    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
-    #       CHANGE `py_modules=['...']` TO `packages=['...']`
-    py_modules=["adafruit_pioasm"],
-)

tests/pytest_helpers.py

@@ -0,0 +1,50 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Pytest helper functions
+"""
+
+try:
+    from typing import Any, List, Optional, Type
+except ImportError:
+    pass
+
+import pytest
+
+import adafruit_pioasm
+
+
+def nice_opcode(opcode: int) -> str:
+    nice = f"{opcode:016b}"
+    return nice[:3] + "_" + nice[3:8] + "_" + nice[8:]
+
+
+def assert_assembles_to(source: str, expected: List[int]) -> None:
+    actual = adafruit_pioasm.assemble(source)
+    expected_bin = [nice_opcode(x) for x in expected]
+    actual_bin = [nice_opcode(x) for x in actual]
+    assert (
+        expected_bin == actual_bin
+    ), f"Assembling {source!r}: Expected {expected_bin}, got {actual_bin}"
+
+
+def assert_assembly_fails(
+    source: str, match: Optional[str] = None, errtype: Type[Exception] = RuntimeError
+) -> None:
+    with pytest.raises(errtype, match=match):
+        adafruit_pioasm.assemble(source)
+    # if match:
+    #    with pytest.raises(errtype, match=match):
+    #        adafruit_pioasm.assemble(source)
+    # else:
+    #    with pytest.raises(errtype):
+    #        adafruit_pioasm.assemble(source)
+
+
+def assert_pio_kwargs(source: str, **kw: Any) -> None:
+    program = adafruit_pioasm.Program(source)
+    assert (
+        kw == program.pio_kwargs
+    ), f"Assembling {source!r}: Expected {kw}, got {program.pio_kwargs}"

tests/test_all.py

@@ -0,0 +1,30 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import all_pio_instructions
+import pytest
+from pytest_helpers import assert_assembles_to
+
+
+def _assert_one(expected, instruction_in, fifo="putget"):
+    program = f"""
+        .program all_pio
+        .pio_version 1
+        .fifo {fifo}
+        {instruction_in}
+        """
+    assert_assembles_to(program, [expected])
+
+
+def assert_one(expected, instruction_in):
+    if isinstance(instruction_in, str):
+        return _assert_one(expected, instruction_in)
+    return _assert_one(expected, instruction_in[0], **instruction_in[1])
+
+
+@pytest.mark.parametrize("arg", all_pio_instructions.all_instruction.items())
+def test_all(arg):
+    expected = arg[0]
+    instruction = arg[1]
+    assert_one(expected, instruction)

tests/test_in.py

@@ -0,0 +1,65 @@
+# SPDX-FileCopyrightText: KB Sriram
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests in
+"""
+
+import pytest
+from pytest_helpers import assert_assembles_to, assert_assembly_fails
+
+
+@pytest.mark.parametrize(
+    "source,expected",
+    [
+        ("pins", 0b000),
+        ("x", 0b001),
+        ("y", 0b010),
+        ("null", 0b011),
+        ("isr", 0b110),
+        ("osr", 0b111),
+    ],
+)
+def test_in_sources(source: str, expected: int) -> None:
+    #                delay src bitcount
+    encoding = 0b010_00000_000_10001
+    # add in the expected source
+    encoding |= expected << 5
+    assert_assembles_to(f"in {source}, 17", [encoding])
+
+
+@pytest.mark.parametrize("delay", [0, 1, 9, 17, 31])
+def test_in_delay(delay: int) -> None:
+    #                delay src bitcount
+    encoding = 0b010_00000_000_10001
+    # add in the expected delay
+    encoding |= delay << 8
+    assert_assembles_to(f"in pins, 17 [{delay}]", [encoding])
+
+
+@pytest.mark.parametrize("bitcount", [1, 9, 17, 32])
+def test_in_bitcount(bitcount: int) -> None:
+    #                delay dst bitcount
+    encoding = 0b010_00000_000_00000
+    # add in the expected bitcount. Note that
+    # 32 should be encoded as 0, which we do by
+    # masking the bitcount with 0x1f
+    encoding |= bitcount & 0x1F
+    assert_assembles_to(f"in pins, {bitcount}", [encoding])
+
+
+def test_in_delay_with_sideset() -> None:
+    source = [
+        ".side_set 2",
+        "in pins 17 side 2 [5]",
+    ]
+    assert_assembles_to("\n".join(source), [0b010_10_101_000_10001])
+
+
+def test_in_bad_source() -> None:
+    assert_assembly_fails("in bad, 17", match="Invalid in source 'bad'", errtype=ValueError)
+
+
+def test_in_bad_bitcount() -> None:
+    assert_assembly_fails("in pins, 0", match="Count out of range", errtype=RuntimeError)

tests/test_label.py

@@ -0,0 +1,56 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests out
+"""
+
+from pytest_helpers import assert_assembly_fails
+
+import adafruit_pioasm
+
+
+def test_label() -> None:
+    source = [
+        "    jmp label1",
+        "label1:",
+        "    jmp label2",
+        "public label2:",
+        "    nop",
+    ]
+    program = adafruit_pioasm.Program("\n".join(source))
+    assert program.public_labels == {"label2": 2}
+
+    # Test each combination of public/privagte label duplication
+    source = [
+        "label1:\n",
+        "nop\n",
+        "public label1:\n",
+        "nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
+
+    source = [
+        "label1:\n",
+        "    nop\n",
+        "label1:\n",
+        "    nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
+
+    source = [
+        "public label1:\n",
+        "    nop\n",
+        "label1:\n",
+        "    nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)
+
+    source = [
+        "public label1:\n",
+        "    nop\n",
+        "public label1:\n",
+        "    nop\n",
+    ]
+    assert_assembly_fails("\n".join(source), match="Duplicate label", errtype=SyntaxError)

tests/test_misc.py

@@ -0,0 +1,35 @@
+# SPDX-FileCopyrightText: KB Sriram
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests out
+"""
+
+from pytest_helpers import assert_assembly_fails
+
+
+def test_invalid_sideset() -> None:
+    source = [
+        ".side_set 2",
+        "side 2 [5]",
+    ]
+    assert_assembly_fails(
+        "\n".join(source), match="Unknown instruction: side", errtype=RuntimeError
+    )
+
+    source = [
+        ".side_set 2",
+        "side 2",
+    ]
+    assert_assembly_fails(
+        "\n".join(source), match="Unknown instruction: side", errtype=RuntimeError
+    )
+
+
+def test_invalid_delay() -> None:
+    assert_assembly_fails("[5]", match=r"Unknown instruction: \[5\]", errtype=RuntimeError)
+
+
+def test_invalid_instruction() -> None:
+    assert_assembly_fails("bad", match=r"Unknown instruction: bad", errtype=RuntimeError)

tests/test_mov.py

@@ -0,0 +1,27 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests mov
+"""
+
+from pytest_helpers import assert_assembles_to, assert_assembly_fails
+
+
+def test_mov_non_happy() -> None:
+    # non happy path
+    assert_assembly_fails("mov x, blah", match="Invalid mov source 'blah'", errtype=ValueError)
+
+
+def test_mov_invert() -> None:
+    # test moving and inverting
+    assert_assembles_to("mov x, ~ x", [0b101_00000_001_01_001])
+    assert_assembles_to("mov x, ~x", [0b101_00000_001_01_001])
+    assert_assembles_to("mov x, !x", [0b101_00000_001_01_001])
+
+
+def test_mov_reverse() -> None:
+    # test moving and reversing bits
+    assert_assembles_to("mov x, :: x", [0b101_00000_001_10_001])
+    assert_assembles_to("mov x, ::x", [0b101_00000_001_10_001])

tests/test_nop.py

@@ -0,0 +1,81 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests nop
+"""
+
+from pytest_helpers import assert_assembles_to, assert_assembly_fails, assert_pio_kwargs
+
+
+def test_nonsense() -> None:
+    assert_assembly_fails("nope")
+
+
+def test_nop() -> None:
+    assert_assembles_to("nop", [0b101_00000_010_00_010])
+    assert_assembles_to("nop\nnop", [0b101_00000_010_00_010, 0b101_00000_010_00_010])
+    assert_assembles_to("nop [1]", [0b101_00001_010_00_010])
+    assert_assembles_to("nop [31]", [0b101_11111_010_00_010])
+    assert_assembles_to(".side_set 1\nnop side 1", [0b101_10000_010_00_010])
+    assert_assembles_to(".side_set 1\nnop side 1 [15]", [0b101_11111_010_00_010])
+
+
+def test_sideset_opt() -> None:
+    assert_assembles_to(".side_set 1 opt\nnop side 1", [0b101_11000_010_00_010])
+    assert_assembles_to(".side_set 1 opt\nnop side 0", [0b101_10000_010_00_010])
+    assert_assembles_to(".side_set 1 opt\nnop side 0 [1]", [0b101_10001_010_00_010])
+    assert_assembles_to(".side_set 1 opt\nnop [1]", [0b101_00001_010_00_010])
+    assert_assembles_to(".side_set 1 opt\nnop [7]", [0b101_00111_010_00_010])
+    assert_assembles_to(".side_set 1 opt\nnop side 1 [1]", [0b101_11001_010_00_010])
+    assert_assembles_to(".side_set 1 opt\nnop side 0 [7]", [0b101_10111_010_00_010])
+
+
+def test_set() -> None:
+    # non happy path
+    assert_assembly_fails("set isr, 1", match="Invalid set destination 'isr'", errtype=ValueError)
+
+
+def test_jmp() -> None:
+    assert_assembles_to("l:\njmp l", [0b000_00000_000_00000])
+    assert_assembles_to("l:\njmp 7", [0b000_00000_000_00111])
+    assert_assembles_to("jmp l\nl:", [0b000_00000_000_00001])
+    assert_assembles_to("jmp !x, l\nl:", [0b000_00000_001_00001])
+    assert_assembles_to("jmp x--, l\nl:", [0b000_00000_010_00001])
+    assert_assembles_to("jmp !y, l\nl:", [0b000_00000_011_00001])
+    assert_assembles_to("jmp y--, l\nl:", [0b000_00000_100_00001])
+    assert_assembles_to("jmp x!=y, l\nl:", [0b000_00000_101_00001])
+    assert_assembles_to("jmp pin, l\nl:", [0b000_00000_110_00001])
+    assert_assembles_to("jmp !osre, l\nl:", [0b000_00000_111_00001])
+    # non happy path
+    assert_assembly_fails(
+        "jmp x--., l\nl:", match="Invalid jmp condition 'x--.'", errtype=ValueError
+    )
+
+
+def test_wait() -> None:
+    assert_assembles_to("wait 0 gpio 0", [0b001_00000_0_00_00000])
+    assert_assembles_to("wait 0 gpio 1", [0b001_00000_0_00_00001])
+    assert_assembles_to("wait 1 gpio 2", [0b001_00000_1_00_00010])
+    assert_assembles_to("wait 0 pin 0", [0b001_00000_0_01_00000])
+    assert_assembles_to("wait 0 pin 1", [0b001_00000_0_01_00001])
+    assert_assembles_to("wait 1 pin 2", [0b001_00000_1_01_00010])
+    assert_assembles_to("wait 0 irq 0", [0b001_00000_0_10_00000])
+    assert_assembles_to("wait 0 irq 0 rel", [0b001_00000_0_10_10000])
+    assert_assembles_to("wait 1 irq 0", [0b001_00000_1_10_00000])
+    assert_assembles_to("wait 0 irq 1 rel", [0b001_00000_0_10_10001])
+
+
+def test_limits() -> None:
+    assert_assembly_fails(".side_set 1\nnop side 2")
+    assert_assembly_fails(".side_set 1\nnop side 2 [1]")
+    assert_assembly_fails("nop [32]")
+    assert_assembly_fails(".side_set 1\nnop side 0 [16]")
+    assert_assembly_fails(".side_set 1 opt\nnop side 0 [8]")
+
+
+def test_cls() -> None:
+    assert_pio_kwargs("", sideset_enable=False)
+    assert_pio_kwargs(".side_set 1", sideset_pin_count=1, sideset_enable=False)
+    assert_pio_kwargs(".side_set 3 opt", sideset_pin_count=3, sideset_enable=True)

tests/test_out.py

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: KB Sriram
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests out
+"""
+
+import pytest
+from pytest_helpers import assert_assembles_to, assert_assembly_fails
+
+
+@pytest.mark.parametrize(
+    "destination,expected",
+    [
+        ("pins", 0b000),
+        ("x", 0b001),
+        ("y", 0b010),
+        ("null", 0b011),
+        ("pindirs", 0b100),
+        ("pc", 0b101),
+        ("isr", 0b110),
+        ("exec", 0b111),
+    ],
+)
+def test_out_destinations(destination: str, expected: int) -> None:
+    #                delay dst bitcount
+    encoding = 0b011_00000_000_10001
+    # add in the expected destination
+    encoding |= expected << 5
+    assert_assembles_to(f"out {destination}, 17", [encoding])
+
+
+@pytest.mark.parametrize("delay", [0, 1, 9, 17, 31])
+def test_out_delay(delay: int) -> None:
+    #                delay dst bitcount
+    encoding = 0b011_00000_000_10001
+    # add in the expected delay
+    encoding |= delay << 8
+    assert_assembles_to(f"out pins, 17 [{delay}]", [encoding])
+
+
+@pytest.mark.parametrize("bitcount", [1, 9, 17, 32])
+def test_out_bitcount(bitcount: int) -> None:
+    #                delay dst bitcount
+    encoding = 0b011_00000_000_00000
+    # add in the expected bitcount. Note that
+    # 32 should be encoded as 0, which we do by
+    # masking the bitcount with 0x1f
+    encoding |= bitcount & 0x1F
+    assert_assembles_to(f"out pins, {bitcount}", [encoding])
+
+
+def test_out_delay_with_sideset() -> None:
+    source = [
+        ".side_set 2",
+        "out pins 17 side 2 [5]",
+    ]
+    assert_assembles_to("\n".join(source), [0b011_10_101_000_10001])
+
+
+def test_out_bad_destination() -> None:
+    assert_assembly_fails("out bad, 17", match="Invalid out destination 'bad'", errtype=ValueError)
+
+
+def test_out_bad_bitcount() -> None:
+    assert_assembly_fails("out pins, 0", match="Count out of range", errtype=RuntimeError)

tests/test_print_c_program.py

@@ -0,0 +1,17 @@
+# SPDX-FileCopyrightText: 2025 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+import contextlib
+import io
+
+import adafruit_pioasm
+
+
+def test_print_c_program():
+    output = io.StringIO()
+    with contextlib.redirect_stdout(output):
+        adafruit_pioasm.Program(".side_set 1 opt").print_c_program("mood")
+    c_program = output.getvalue()
+    assert "True" not in c_program
+    assert "sideset_enable = 1" in c_program

tests/test_pseudo.py

@@ -0,0 +1,31 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests pseudo-ops
+"""
+
+from pytest_helpers import assert_assembly_fails, assert_pio_kwargs
+
+
+def test_offset() -> None:
+    assert_pio_kwargs(".origin 7", offset=7, sideset_enable=False)
+    assert_assembly_fails("nop\n.origin 7")
+
+
+def test_sideset_pindirs() -> None:
+    assert_pio_kwargs(
+        ".side_set 2 opt pindirs",
+        sideset_pin_count=2,
+        sideset_enable=True,
+        sideset_pindirs=True,
+    )
+    assert_pio_kwargs(
+        ".side_set 2 pindirs",
+        sideset_pin_count=2,
+        sideset_enable=False,
+        sideset_pindirs=True,
+    )
+    # Setting not emitted (as =False) for backwards compat
+    assert_pio_kwargs(".side_set 2", sideset_pin_count=2, sideset_enable=False)

tests/test_radix.py

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests radix
+"""
+
+from pytest_helpers import assert_assembles_to
+
+
+def test_octal() -> None:
+    assert_assembles_to(".side_set 0o1\nset x, 0o11", [0b111_00000_001_01001])
+
+
+def test_binary() -> None:
+    assert_assembles_to(".side_set 0b101\nnop side 0b10001", [0b101_10001_010_00_010])
+
+
+def test_hex() -> None:
+    assert_assembles_to(".side_set 0x0\nnop [0x10]", [0b101_10000_010_00_010])

tests/test_version.py

@@ -0,0 +1,146 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests version dependent instructions
+"""
+
+from pytest_helpers import assert_assembles_to, assert_assembly_fails, assert_pio_kwargs
+
+
+def test_version() -> None:
+    assert_pio_kwargs(".pio_version 0", sideset_enable=0)
+    assert_pio_kwargs(".pio_version 1", pio_version=1, sideset_enable=0)
+    assert_assembly_fails(".pio_version muffin", errtype=ValueError)
+    assert_assembly_fails(".pio_version -1")
+
+
+def test_fifo() -> None:
+    assert_pio_kwargs(".fifo txrx", sideset_enable=0, fifo_type="txrx")
+    assert_pio_kwargs(".fifo auto", sideset_enable=0)
+    assert_assembly_fails(".fifo txput")
+    assert_pio_kwargs(
+        ".pio_version 1\n.fifo txput",
+        pio_version=1,
+        sideset_enable=0,
+        fifo_type="txput",
+    )
+
+
+def test_mov_status() -> None:
+    assert_pio_kwargs(
+        ".mov_status txfifo < 5",
+        sideset_enable=0,
+        mov_status_type="txfifo",
+        mov_status_n=5,
+    )
+    assert_pio_kwargs(
+        ".mov_status rxfifo < 8",
+        sideset_enable=0,
+        mov_status_type="rxfifo",
+        mov_status_n=8,
+    )
+    assert_assembly_fails(".mov_status rxfifo < -1")
+    assert_assembly_fails(".mov_status rxfifo < 33")
+    assert_assembly_fails(".mov_status irq next set 3")
+    assert_pio_kwargs(
+        ".pio_version 1\n.mov_status irq prev set 3",
+        pio_version=1,
+        sideset_enable=0,
+        mov_status_type="irq",
+        mov_status_n=3 | 0x8,
+    )
+    assert_pio_kwargs(
+        ".pio_version 1\n.mov_status irq next set 3",
+        pio_version=1,
+        sideset_enable=0,
+        mov_status_type="irq",
+        mov_status_n=3 | 0x10,
+    )
+    assert_pio_kwargs(
+        ".pio_version 1\n.mov_status irq set 3",
+        pio_version=1,
+        sideset_enable=0,
+        mov_status_type="irq",
+        mov_status_n=3,
+    )
+    assert_assembly_fails(".pio_version 1\n.mov_status irq prev set 9")
+
+
+def test_dot_in() -> None:
+    assert_pio_kwargs(
+        ".in 32 left auto 11",
+        sideset_enable=0,
+        auto_push=True,
+        push_threshold=11,
+        in_shift_right=False,
+    )
+    assert_assembly_fails(".in 16")
+    assert_pio_kwargs(
+        ".pio_version 1\n.in 16 right",
+        pio_version=1,
+        sideset_enable=0,
+        in_pin_count=16,
+        auto_push=False,
+        in_shift_right=True,
+    )
+
+
+def test_dot_out() -> None:
+    assert_pio_kwargs(
+        ".out 32 left auto 11",
+        sideset_enable=0,
+        auto_pull=True,
+        pull_threshold=11,
+        out_shift_right=False,
+    )
+    assert_pio_kwargs(
+        ".out 16 right",
+        sideset_enable=0,
+        out_pin_count=16,
+        auto_pull=False,
+        out_shift_right=True,
+    )
+
+
+def test_dot_set() -> None:
+    assert_pio_kwargs(".set 5", sideset_enable=0, set_pin_count=5)
+    assert_assembly_fails(".set 16")
+    assert_assembly_fails(".pio_version 1\n.set 16")
+    assert_assembly_fails(".set 3")
+    assert_pio_kwargs(
+        ".pio_version 1\n.set 3 right", pio_version=1, sideset_enable=0, set_pin_count=3
+    )
+
+
+def test_irq_v1() -> None:
+    assert_assembly_fails("irq next 7")
+    assert_assembly_fails(".pio_version 1\nirq next 7 rel")
+    assert_assembles_to(".pio_version 1\nirq next 5", [0b110_00000_0_0_0_11_101])
+    assert_assembles_to(".pio_version 1\nirq wait prev 1", [0b110_00000_0_0_1_01_001])
+
+
+def test_mov_v1() -> None:
+    assert_assembly_fails("mov osr, rxfifo[y]")
+    assert_assembly_fails(".pio_version 1\nmov osr, rxfifo[y]")
+    prefix = ".pio_version 1\n.fifo putget\n"
+    assert_assembly_fails(prefix + "mov osr, rxfifo[8]")
+    assert_assembles_to(prefix + "mov rxfifo[y], isr", [0b100_00000_0001_0_000])
+    assert_assembles_to(prefix + "mov osr, rxfifo[1]", [0b100_00000_1001_1_001])
+
+    assert_assembly_fails("mov pindirs, null", errtype=ValueError)
+    assert_assembles_to(prefix + "mov pindirs, null", [0b101_00000_01100011])
+
+
+def test_wait_v1() -> None:
+    assert_assembly_fails("wait 0 jmppin")
+    assert_assembly_fails("wait 0 irq next 5")
+    prefix = ".pio_version 1\n"
+    assert_assembly_fails(prefix + "wait 0 jmppin +")
+    assert_assembly_fails(prefix + "wait 0 jmppin + 7")
+    assert_assembles_to(prefix + "wait 0 jmppin + 3", [0b001_00000_0_11_00011])
+    assert_assembles_to(prefix + "wait 1 jmppin", [0b001_00000_1_11_00000])
+
+    assert_assembles_to(prefix + "wait 0 irq next 5", [0b001_00000_0_10_11_101])
+    assert_assembles_to(prefix + "wait 1 irq prev 4", [0b001_00000_1_10_01_100])

tests/test_wrap.py

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Tests wrap
+"""
+
+from pytest_helpers import assert_assembly_fails, assert_pio_kwargs
+
+
+def test_wrap() -> None:
+    assert_assembly_fails(".wrap")
+    assert_pio_kwargs(
+        "nop\n.wrap_target\nnop\nnop\n.wrap",
+        sideset_enable=False,
+        wrap=2,
+        wrap_target=1,
+    )

tests/testpioasm.py

@@ -1,69 +0,0 @@
-# SPDX-FileCopyrightText: 2021 Jeff Epler, written for Adafruit Industries
-#
-# SPDX-License-Identifier: MIT
-
-# pylint: disable=missing-module-docstring,invalid-name,missing-function-docstring,missing-class-docstring
-
-import pathlib
-import sys
-import unittest
-
-sys.path.insert(0, str(pathlib.Path(__file__).absolute().parent.parent))
-
-import adafruit_pioasm  # pylint: disable=wrong-import-position
-
-
-def nice_opcode(o):
-    o = f"{o:016b}"
-    return o[:3] + "_" + o[3:8] + "_" + o[8:]
-
-
-class TestNop(unittest.TestCase):
-    def assertAssemblesTo(self, source, expected):
-        actual = adafruit_pioasm.assemble(source)
-        expected_bin = [nice_opcode(x) for x in expected]
-        actual_bin = [nice_opcode(x) for x in actual]
-        self.assertEqual(
-            expected_bin,
-            actual_bin,
-            f"Assembling {source!r}: Expected {expected_bin}, got {actual_bin}",
-        )
-
-    def assertAssemblyFails(self, source):
-        self.assertRaises(RuntimeError, adafruit_pioasm.assemble, source)
-
-    def testNonsense(self):
-        self.assertAssemblyFails("nope")
-
-    def testNop(self):
-        self.assertAssemblesTo("nop", [0b101_00000_010_00_010])
-        self.assertAssemblesTo(
-            "nop\nnop", [0b101_00000_010_00_010, 0b101_00000_010_00_010]
-        )
-        self.assertAssemblesTo("nop [1]", [0b101_00001_010_00_010])
-        self.assertAssemblesTo(".side_set 1\nnop side 1", [0b101_10000_010_00_010])
-        self.assertAssemblesTo(".side_set 1\nnop side 1 [1]", [0b101_10001_010_00_010])
-
-    def testJmp(self):
-        self.assertAssemblesTo("l:\njmp l", [0b000_00000_000_00000])
-        self.assertAssemblesTo("l:\njmp 7", [0b000_00000_000_00111])
-        self.assertAssemblesTo("jmp l\nl:", [0b000_00000_000_00001])
-        self.assertAssemblesTo("jmp !x, l\nl:", [0b000_00000_001_00001])
-        self.assertAssemblesTo("jmp x--, l\nl:", [0b000_00000_010_00001])
-        self.assertAssemblesTo("jmp !y, l\nl:", [0b000_00000_011_00001])
-        self.assertAssemblesTo("jmp y--, l\nl:", [0b000_00000_100_00001])
-        self.assertAssemblesTo("jmp x!=y, l\nl:", [0b000_00000_101_00001])
-        self.assertAssemblesTo("jmp pin, l\nl:", [0b000_00000_110_00001])
-        self.assertAssemblesTo("jmp !osre, l\nl:", [0b000_00000_111_00001])
-
-    def testWait(self):
-        self.assertAssemblesTo("wait 0 gpio 0", [0b001_00000_0_00_00000])
-        self.assertAssemblesTo("wait 0 gpio 1", [0b001_00000_0_00_00001])
-        self.assertAssemblesTo("wait 1 gpio 2", [0b001_00000_1_00_00010])
-        self.assertAssemblesTo("wait 0 pin 0", [0b001_00000_0_01_00000])
-        self.assertAssemblesTo("wait 0 pin 1", [0b001_00000_0_01_00001])
-        self.assertAssemblesTo("wait 1 pin 2", [0b001_00000_1_01_00010])
-        self.assertAssemblesTo("wait 0 irq 0", [0b001_00000_0_10_00000])
-        self.assertAssemblesTo("wait 0 irq 0 rel", [0b001_00000_0_10_10000])
-        self.assertAssemblesTo("wait 1 irq 0", [0b001_00000_1_10_00000])
-        self.assertAssemblesTo("wait 0 irq 1 rel", [0b001_00000_0_10_10001])

tools/make_all.py

@@ -0,0 +1,128 @@
+# SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
+"""
+Generate test cases for adafruit_pioasm, with expected results from sdk pioasm
+"""
+
+import re
+from subprocess import check_output
+
+PIOASM = "/home/jepler/src/circuitpython/ports/raspberrypi/sdk/tools/pioasm/build/pioasm"
+
+
+def assemble_one_instruction(instruction_in):
+    if isinstance(instruction_in, str):
+        return _assemble_one_instruction(instruction_in)
+    return _assemble_one_instruction(instruction_in[0], **instruction_in[1])
+
+
+def _assemble_one_instruction(instruction_in, fifo="putget"):
+    nops = "\n".join("nop" for _ in range(31))
+    program = f"""
+        .program all_pio
+        .pio_version 1
+        .fifo {fifo}
+        {instruction_in}
+        {nops}
+        """
+    output = check_output([PIOASM, "/dev/stdin", "/dev/stdout"], input=program, encoding="utf-8")
+    return int(re.search("0x[0-9a-f]{4}", output).group(0), 16)
+
+
+def all_jmp():
+    for i in range(32):
+        yield f"jmp {i}"
+        for cond in "!x", "x--", "!y", "y--", "x!=y", "pin", "!osre":
+            yield f"jmp {cond} {i}"
+
+
+def all_wait():
+    for polarity in range(2):
+        yield f"wait {polarity} jmppin"
+        for source in "gpio", "pin":
+            for i in range(32):
+                yield f"wait {polarity} {source} {i}"
+        for i in range(8):
+            yield f"wait {polarity} irq {i} rel"
+            for what in "prev", "next":
+                yield f"wait {polarity} irq {what} {i}"
+        for i in range(1, 4):
+            yield f"wait {polarity} jmppin + {i}"
+
+
+def all_in():
+    for source in "pins", "x", "y", "null", "isr", "osr":
+        for bit_count in range(1, 33):
+            yield f"in {source} {bit_count}"
+
+
+def all_out():
+    for dest in "pins", "x", "y", "null", "pindirs", "pc", "isr", "exec":
+        for bit_count in range(1, 33):
+            yield f"out {dest} {bit_count}"
+
+
+def all_push():
+    yield "push", {"fifo": "txrx"}
+    yield "push iffull block", {"fifo": "txrx"}
+    yield "push iffull noblock", {"fifo": "txrx"}
+
+
+def all_pull():
+    yield "pull", {"fifo": "txrx"}
+    yield "pull ifempty block", {"fifo": "txrx"}
+    yield "pull ifempty noblock", {"fifo": "txrx"}
+
+
+def all_mov():
+    for dest in ("pins", "x", "y", "pindirs", "exec", "pc", "isr", "osr"):
+        for source in ("pins", "x", "y", "null", "status", "isr", "osr"):
+            for operator in "", "~", "::":
+                yield f"mov {dest} {operator}{source}"
+    for where in 0, 1, 2, 3, "y":
+        yield f"mov rxfifo[{where}], isr"
+        yield f"mov osr, rxfifo[{where}]"
+
+
+def all_irq():
+    for i in range(8):
+        yield f"irq {i}"
+        yield f"irq {i} rel"
+        for what in "prev", "next":
+            yield f"irq {what} {i}"
+
+
+def all_set():
+    for dest in ("pins", "x", "y", "pindirs"):
+        for i in range(32):
+            yield f"set {dest} {i}"
+
+
+def all_instructions():
+    yield from all_jmp()
+    yield from all_wait()
+    yield from all_in()
+    yield from all_out()
+    yield from all_push()
+    yield from all_pull()
+    yield from all_mov()
+    yield from all_irq()
+    yield from all_set()
+
+
+if __name__ == "__main__":
+    print(
+        """\
+# SPDX-FileCopyrightText: 2024 Jeff Epler, written for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+# fmt: off
+"""
+    )
+    print("all_instruction = {")
+    for instr in all_instructions():
+        assembled = assemble_one_instruction(instr)
+        print(f"    {assembled}: {instr!r},")
+    print("}")