The code base had evolved through several code names, interim
names, company names and chip names that alternatively did or did
not exist.
Baochip is the definitive name of the company, and the Baochip1x
(full part number BAO1X2S4F-WA) is the definitivey part number of
the SoC. For convenience, the part number is shortened to 'bao1x'
in most feature flags and variable references.
This commit fixes all of the odd names and removes some unmaintained
early targets.
The hardware specification hierarchy is clarified to be as such:
- A `soc` flag specifies dependencies that are generic to a
system-on-chip (SoC). For example, the locations of registers, or
the extents of memory regions contained in the `soc`.
- A `board` flag specifies dependencies that are specific to a
board. For example, the resolution of displays, pin mappings to
peripherals, and sizes of external memory. Typically, a board
assumes a `soc`, so both a `board-*` and `*-soc` set of flags are
required to fully specify a build.
- Precursor (the first target for Xous) did not hold to this
abstraction and conflated the two, so it is a special case in the
build system.
- "Hosted" mode emulations are considered to be a `board` target; the
`soc` is assumed to be the host (linux, windows, etc.)
Since all builds require a `board` specifier, documentation now
requires a `doc-deps` flag to be passed. This effectively specifies a
set of dummy board dependencies so that the documentation can
build. Here is the recommended command line for building docs: `cargo
doc --no-deps --feature doc-deps`
a lot of re-import warnings have cropped up. While I appreciate
their studiousness on this, the problem is that removing some
of these exports in the API crate could mean that future users
who want access to some API features that aren't used in this
configuration are now unaccessible.
I think it's not a huge problem at the moment, just spam-cleaning
the warnings because there are too many to deal with carefully
at the moment.