]> sigrok.org Git - libsigrok.git/blobdiff - README.devices
ols: Fix serial port timeout.
[libsigrok.git] / README.devices
index 554805a948c2e554913c2a9eabdeeca9919c3252..1ea445bc23b07011865849128f04a978528f951b 100644 (file)
@@ -35,7 +35,7 @@ The following drivers/devices require a firmware upload upon connection:
 
  - fx2lafw: Logic analyzers based on the Cypress FX2(LP) chip need the
    firmware files from the 'sigrok-firmware-fx2lafw' repository/project.
-   The firmware is written from scratch and licensed under the GPLv2+.
+   The firmware is written from scratch and licensed under the GNU GPLv2+.
 
  - hantek-dso: The Hantek DSO-2090 (and other supported models of the same
    series of Hantek PC oscilloscopes) need firmware files.
@@ -47,20 +47,25 @@ The following drivers/devices require a firmware upload upon connection:
    These can be extracted from the vendor's Linux application using a tool
    from our 'sigrok-util' repository/project.
 
+ - sysclk-lwla: The Sysclk LWLA1034 requires various bitstream files.
+   These files are available from our 'sigrok-firmware' repository/project
+   under a license which allows us to redistribute them.
+
 The following drivers/devices do not need any firmware upload:
 
  - agilent-dmm
- - alsa
  - appa-55ii
+ - atten-pps3xxx
  - brymen-bm86x
  - brymen-dmm
  - cem-dt-885x
  - center-3xx (including all subdrivers)
  - chronovu-la
  - colead-slm
+ - conrad-digi-35-cpu
  - demo
  - fluke-dmm
- - gmc-mh-1x-2x
+ - gmc-mh-1x-2x (including all subdrivers)
  - hameg-hmo
  - ikalogic-scanalogic2
  - ikalogic-scanaplus
@@ -70,6 +75,7 @@ The following drivers/devices do not need any firmware upload:
  - mic-985xx (including all subdrivers)
  - norma-dmm
  - openbench-logic-sniffer
+ - pipistrello-ols
  - rigol-ds
  - serial-dmm (including all subdrivers)
  - teleinfo
@@ -77,6 +83,7 @@ The following drivers/devices do not need any firmware upload:
  - uni-t-dmm (including all subdrivers)
  - uni-t-ut32x
  - victor-dmm
+ - yokogawa-dlm
  - zeroplus-logic-cube
 
 
@@ -98,12 +105,14 @@ The following drivers/devices require a serial port specification:
 
  - agilent-dmm
  - appa-55ii
+ - atten-pps3xxx
  - brymen-dmm
  - cem-dt-885x
  - center-3xx (including all subdrivers)
  - colead-slm
+ - conrad-digi-35-cpu
  - fluke-dmm
- - gmc-mh-1x-2x
+ - gmc-mh-1x-2x (including all subdrivers)
  - hameg-hmo
  - link-mso19
  - mic-985xx (including all subdrivers)
@@ -116,7 +125,6 @@ The following drivers/devices require a serial port specification:
 
 The following drivers/devices do not require a serial port specification:
 
- - alsa
  - asix-sigma
  - brymen-bm86x
  - chronovu-la
@@ -127,11 +135,14 @@ The following drivers/devices do not require a serial port specification:
  - ikalogic-scanaplus
  - kecheng-kc-330b
  - lascar-el-usb
+ - pipistrello-ols
  - rigol-ds (USBTMC or TCP)
  - saleae-logic16
+ - sysclk-lwla
  - uni-t-dmm (including all subdrivers)
  - uni-t-ut32x
  - victor-dmm
+ - yokogawa-dlm (USBTMC or TCP)
  - zeroplus-logic-cube
 
 
@@ -141,7 +152,7 @@ Specifiying serial port parameters
 Every serial device's driver has default serial port parameters like baud
 rate, number of data bits, stop bits and handshake status. If a device requires
 different parameters, pass them as option "serialcomm" with the driver name.
-See libsigrok docs for function serial_set_paramstr() for complete specs.
+See libsigrok docs for the function serial_set_paramstr() for complete specs.
 
 Example:
 
@@ -316,30 +327,6 @@ a short list for convenience:
  - Voltcraft VC-830: Press the "REL/PC" button for roughly 2 seconds.
 
 
-ALSA driver
------------
-
-The 'alsa' driver can be used to sample analog data using a PC's soundcard.
-I.e. the sound card can act as a simple oscilloscope (with some limitations)
-using commercial or DIY "sound card scope probe" cables.
-
-Since ALSA is a Linux-specific sound system, this driver will inherently
-only compile and work on Linux.
-
-We might write additional drivers to make a similar functionality available
-on other OSes at some point.
-
-
-Link Instruments MSO-19
------------------------
-
-The driver for the Link Instruments MSO-19 mixed-signal oscilloscope (MSO)
-is currently using libudev (which is a library for the Linux-specific udev
-system). Thus, this driver can currently only compile and work on Linux.
-
-We plan to fix this though, so that it'll work on all other OSes, too.
-
-
 ChronoVu LA8/LA16 USB VID/PIDs
 ------------------------------
 
@@ -358,11 +345,10 @@ automatically finds devices with either VID/PID pair.
 OLS
 ---
 
-The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer is
-supported by the 'ols' driver in libsigrok. This driver assumes a somewhat
-recent firmware has been flashed onto the OLS (it doesn't need a firmware
-upload every time it's attached via USB, since the firmware is stored in the
-device permanently).
+The Dangerous Prototypes Openbench Logic Sniffer (OLS) logic analyzer
+driver in libsigrok assumes a somewhat recent firmware has been flashed onto
+the OLS (it doesn't need a firmware upload every time it's attached via USB,
+since the firmware is stored in the device permanently).
 
 The most recent firmware version that is tested is 3.07.
 
@@ -380,20 +366,3 @@ Example:
 
  $ sigrok-cli --driver ols:conn=/dev/ttyACM0 ...
 
-
-Rigol DS oscilloscopes
-----------------------
-
-The 'rigol-ds' driver (for the Rigol DS series DSOs) currently uses the Linux
-usbtmc kernel driver. This means it can currently only be built and used on
-Linux (i.e., it's non-portable).
-
-The use of a kernel module also means it is dependent on the kernel version
-used, as well as on whether this specific module is available in the kernel.
-Additionally, the usbtmc kernel module has been known to have various bugs
-in some versions. These are some (but not all) drawbacks of using a kernel
-module as opposed to a libusb-based driver that works in user-space.
-
-We plan to change the driver to use the 'librevisa' user-space shared
-library (which uses libusb) soon, which will fix all these issues and make
-the driver portable at the same time.