annotate README @ 107:bc3367755586 default tip

add INSTALL document
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 21 Nov 2023 22:11:09 +0000
parents f2542deec11a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
103
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
1 The present package is a set of tools for working with USB-serial interface
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
2 chips, specifically those FTDI and Silabs chips that are of relevance to
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
3 FreeCalypso. The following tools are included:
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
4
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
5 * Utilities for examining the non-volatile baud rate configuration on CP2102
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
6 adapters and for reprogramming their EEPROM, switching between "standard"
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
7 230400/460800/921600 and GSM-specific 203125/406250/812500 baud rates;
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
8
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
9 * A utility for switching a FreeCalypso DUART28 adapter between C and S
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
10 configurations, as well as checking the current configuration;
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
11
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
12 * General-purpose FT2232x and FT232R EEPROM programming tools.
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
13
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
14 The common theme across all of these tools is that they talk to a USB-interfaced
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
15 chip at the native USB level, bypassing the usual abstraction of ttyUSB, and
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
16 thus require libusb. More specifically, our tools are built on libusb-0.x API,
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
17 consisting of <usb.h> include header and -lusb link library pull-in; on "modern"
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
18 systems these pieces will typically be provided by libusb-compat-0.1 package
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
19 wrapping around libusb-1.x, but in the spirit of Holy retrocomputing, really old
f2542deec11a README: update for release-ready state
Mychaela Falconia <falcon@freecalypso.org>
parents: 8
diff changeset
20 systems can be used with native libusb-0.1.