Difference between revisions of "Saleae Logic"

From sigrok
Jump to navigation Jump to search
(→‎Getting the firmware: Instructions for more recent Saleae software releases / firmware.)
m (Voltages, thresholds.)
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[File:Saleae Logic.jpg|thumb|right|Saleae Logic]]
{{Infobox logic analyzer
[[File:Saleae logic.jpg|thumb|right|Saleae Logic with two E-Z-Hooks attached]]
| image            = [[File:Saleae Logic.png|180px]]
[[File:Saleae logic opened.jpg|thumb|right|Saleae Logic, case open]]
| name            = Saleae Logic
[[File:Saleae logic pcb front.jpg|thumb|right|Saleae Logic PCB front]]
| status          = supported
[[File:Saleae logic pcb back.jpg|thumb|right|Saleae Logic PCB back]]
| source_code_dir  = fx2lafw
[[File:Saleae logic collection.jpg|thumb|right|Saleae Logic collection]]
| channels        = 8
| samplerate      = 24MHz
| samplerate_state = —
| triggers        = none (SW-only)
| voltages        = -0.5V — 5.25V
| threshold        = Fixed: VIH=2.0V—5.25V, VIL=-0.5V—0.8V
| memory          = none
| compression      = none
| website          = [http://www.saleae.com/logic/ saleae.com]
}}


The [http://www.saleae.com/logic/ Saleae Logic] is a 24MHz, 8-channel, USB-based logic analyzer.
The '''Saleae Logic''' is a USB-based, 8-channel logic analyzer with up to 24MHz sampling rate.


The unit itself is very small, and has a USB 2.0 port connecting it to a PC (and powering the unit) and a connector for the 8 + 1 probe set. It is built around a Cypress EZ-USB FX2LP microcontroller — an 8051-compatible chip with built-in USB 2.0 controller. It can sample 8 channels up to 24MHz and sells for $150.
The unit itself is very small, and has a USB 2.0 port connecting it to a PC (and powering the unit) and a connector for the 8 + 1 probe set. It is built around a Cypress EZ-USB FX2LP microcontroller — an 8051-compatible chip with built-in USB 2.0 controller. It can sample 8 channels up to 24MHz.
 
In sigrok, we use the open-source [[fx2lafw]] firmware for this logic analyzer.


See [[Saleae Logic/Info]] for more details (such as '''lsusb -vvv''' output) about the device.
See [[Saleae Logic/Info]] for more details (such as '''lsusb -vvv''' output) about the device.
Line 14: Line 25:
See [[Saleae Logic16]] for the successor product of the Saleae Logic.
See [[Saleae Logic16]] for the successor product of the Saleae Logic.


== Components ==
== Hardware ==


* Main chip: Cypress CY7C68013A-56PVXC (SSOP)
* '''Main chip:''' Cypress CY7C68013A-56PVXC (FX2LP)
* ESD protection: ST DVIULC6-4SC6
* '''ESD protection''': ST DVIULC6-4SC6
* 3.3V voltage regulator: ST LD33C
* '''3.3V voltage regulator''': ST LD33C
* I2C EEPROM: Unknown (marking: M0KS / MOKS)
* '''I2C EEPROM''': Microchip 24LC00
* Crystal: 24MHz
* '''Crystal''': 24MHz


== Protocol ==
The case has four '''Torx T2''' screws you need to remove in order to be able to open it.


The Saleae Logic reports on the USB bus with vendor ID '''0x0925''', product ID '''0x3881''' (see also the [[Saleae Logic/Info|full lsusb]]). It has no firmware on board; this must be uploaded when the unit is powered on. The standard procedure for the FX2LP chip is used for this. After the firmware is on board, the chip resets and announces itself on the USB bus with the same vendor and product IDs, but this time with only two endpoints: '''endpoint 1 (out)''' is used for sending commands to the logic analyzer, '''endpoint 2 (in)''' is for transfers of sample sets. Both endpoints are of type '''bulk'''.
== Photos ==


The Saleae Logic does no analysis in hardware at all. Processing triggers, protocol analysis and so on is all done on the software side; the hardware unit merely sends the requested number of samples at a given sample rate. The device has 8 probes, all of which are always probed and sent along. A full sample is thus always exactly one byte.
<gallery>
File:Saleae Logic.jpg|<small>Device, top</small>
File:Saleae logic.jpg|<small>Device with two E-Z-Hooks</small>
File:Saleae logic opened.jpg|<small>Device, open</small>
File:Saleae logic pcb front.jpg|<small>PCB, front</small>
File:Saleae logic pcb back.jpg|<small>PCB, back</small>
File:Saleae logic collection.jpg|<small>Saleae Logic collection</small>
</gallery>


=== Setting the samplerate, starting an acquisition ===
== Protocol ==
 
There is only one command the software sends to the Saleae Logic on '''endpoint 1''': a '''two-byte command''' to set the samplerate. The '''first byte''' is always '''0x01''' ('''0xd5''' on more recent firmware versions). This is likely a command opcode meaning "set sample rate".
 
The '''second byte''' indicates the samplerate. The samplerate is given in the form of a divider based on the FX2LP's clock, which runs at 48MHz. The following formula is used:
 
samplerate = 48 / (1 + divider)
 
Thus, a samplerate of 2 MHz (for example) is selected by using 23 as the divider:
 
{| border="0" style="font-size: smaller"
|- bgcolor="#6699ff"
!1st byte
!2nd byte
|- bgcolor="#eeeeee"
| 0x01 (1)
| 0x17 (23)
|}
 
=== Supported samplerates ===
 
The following samplerates are supported in older firmware versions:
 
{| border="0" style="font-size: smaller"
|- bgcolor="#6699ff"
!Samplerate
!Divider (hex)
!Divider (int)
|- bgcolor="#eeeeee"
| 200 kHz
| 0xef
| 239
|- bgcolor="#dddddd"
| 250 kHz
| 0xbf
| 191
|- bgcolor="#eeeeee"
| 500 kHz
| 0x5f
| 95
|- bgcolor="#dddddd"
| 1 MHz
| 0x2f
| 47
|- bgcolor="#eeeeee"
| 2 MHz
| 0x17
| 23
|- bgcolor="#dddddd"
| 4 MHz
| 0x0b
| 11
|- bgcolor="#eeeeee"
| 8 MHz
| 0x05
| 5
|- bgcolor="#dddddd"
| 12 MHz
| 0x03
| 3
|- bgcolor="#eeeeee"
| 16 MHz
| 0x02
| 2
|- bgcolor="#dddddd"
| 24 MHz
| 0x01
| 1
|}
 
Recent versions of the vendor software have additional samplerate settings of '''100 kHz''', '''50 kHz''', and '''25 kHz'''. However, these result in the same divider value of '''239''' (and the software likely just uses every 2nd/4th/8th sample) as with the 200 kHz samplerate, so they're not really too useful.
 
The following samplerates are supported in newer firmware versions:
 
{| border="0" style="font-size: smaller"
|- bgcolor="#6699ff"
!Samplerate
!Divider (hex)
!Divider (int)
|- bgcolor="#eeeeee"
| 200 kHz
| 0x4e
| 78
|- bgcolor="#dddddd"
| 250 kHz
| 0x9e
| 158
|- bgcolor="#eeeeee"
| 500 kHz
| 0xfe
| 254
|- bgcolor="#dddddd"
| 1 MHz
| 0x8e
| 142
|- bgcolor="#eeeeee"
| 2 MHz
| 0xe6
| 230
|- bgcolor="#dddddd"
| 4 MHz
| 0xda
| 218
|- bgcolor="#eeeeee"
| 8 MHz
| 0xd4
| 212
|- bgcolor="#dddddd"
| 12 MHz
| 0xe2
| 226
|- bgcolor="#eeeeee"
| 16 MHz
| 0xd5
| 213
|- bgcolor="#dddddd"
| 24 MHz
| 0xe0
| 224
|}
 
=== Getting samples ===
 
Samples are read off '''endpoint 2'''. The Saleae Logic receives a read request from the host, and responds by sending the requested number of samples. The maximum number of samples transferred at a time is 4096, a constraint in the USB protocol. A sample is one byte, with each bit representing the state of one of the probes. Probe 1 (black wire) is in the MSB of the sample, probe 8 (purple wire) is the LSB.
 
== Getting the firmware ==
 
The firmware required for the Cypress FX2 chip on the Saleae Logic is proprietary and can't be distributed with sigrok. But if you have a Saleae Logic, you can go and download the official software, install it somewhere (e.g. using '''wine''') and/or extract the required data (e.g. using '''cabextract'''). Unfortunately the firmware doesn't exist as a separate file, it's embedded in another file.
 
=== Old firmware versions ===
 
For older Saleae software releases, a file named '''WinUSBLogicInterface.dll''' or '''USBDeviceInterface.dll''' contains the firmware.
 
The following lines must be used with the software [http://www.saleae.com/downloads/logic/Logic%20Setup%20Beta.exe 1.0.33 Beta for WinXP/Vista/7]:
 
$ '''cabextract Logic\ Setup\ Beta.exe'''
$ '''dd if=WinUSBLogicInterface.dll of=fw.hex skip=8036 count=17366 bs=1'''
 
The following lines must be used with the software [http://www.saleae.com/downloads/logic/Logic%20Setup.exe 1.0.21 for WinXP/Vista/7].
 
$ '''cabextract Logic\ Setup.exe'''
$ '''dd if=USBDeviceInterface.dll of=fw.hex skip=4220 count=17366 bs=1'''
 
Then:
 
$ '''objcopy -Iihex fw.hex -Obinary saleae-logic.fw'''
 
=== New firmware versions ===
 
More recent firmware versions need a different method to acquire the firmware:
 
Download the [http://downloads.saleae.com/Logic%20Setup%201.1.15%20(32-bit).exe 1.1.15 (32-bit)] version of the software. Then:
 
$ '''cabextract Logic\ Setup\ 1.1.15\ \(32-bit\).exe'''
$ '''dd if=Logic.exe of=fw.hex skip=9278024 count=42631 bs=1'''
$ '''strings fw.hex | tail -1147 > fw2.hex'''
$ '''echo ":00000001FF" >> fw2.hex'''
$ '''objcopy -Iihex fw2.hex -Obinary saleae-logic.fw'''


=== Firmware file location ===
Since we use the open-source [[fx2lafw]] firmware for this device, we don't need to know the protocol.


The resulting '''saleae-logic.fw''' file is usable by sigrok directly, just copy it into the '''/usr/local/share/libsigrok/firmware''' directory (may differ if you used the '''--prefix''' option of '''configure''').
However, for those interested in this, see our old [[Saleae_Logic/Info#Vendor_USB_protocol|vendor protocol docs]].


Recent versions of libsigrok support both the older and newer Saleae Logic firmware.
== Resources ==


== Random notes ==
* [http://downloads.saleae.com/Logic+Guide.pdf User's guide]
* [http://www.saleae.com/downloads Vendor software]
* [http://community.saleae.com/ SDKs]


The case has four '''Torx T2''' screws you need to remove in order to be able to open it.
[[Category:Device]]
[[Category:Logic analyzer]]
[[Category:Supported]]

Latest revision as of 12:07, 28 July 2013

Saleae Logic
Saleae Logic.png
Status supported
Source code fx2lafw
Channels 8
Samplerate 24MHz
Samplerate (state)
Triggers none (SW-only)
Min/max voltage -0.5V — 5.25V
Threshold voltage Fixed: VIH=2.0V—5.25V, VIL=-0.5V—0.8V
Memory none
Compression none
Website saleae.com

The Saleae Logic is a USB-based, 8-channel logic analyzer with up to 24MHz sampling rate.

The unit itself is very small, and has a USB 2.0 port connecting it to a PC (and powering the unit) and a connector for the 8 + 1 probe set. It is built around a Cypress EZ-USB FX2LP microcontroller — an 8051-compatible chip with built-in USB 2.0 controller. It can sample 8 channels up to 24MHz.

In sigrok, we use the open-source fx2lafw firmware for this logic analyzer.

See Saleae Logic/Info for more details (such as lsusb -vvv output) about the device.

See Saleae Logic16 for the successor product of the Saleae Logic.

Hardware

  • Main chip: Cypress CY7C68013A-56PVXC (FX2LP)
  • ESD protection: ST DVIULC6-4SC6
  • 3.3V voltage regulator: ST LD33C
  • I2C EEPROM: Microchip 24LC00
  • Crystal: 24MHz

The case has four Torx T2 screws you need to remove in order to be able to open it.

Photos

Protocol

Since we use the open-source fx2lafw firmware for this device, we don't need to know the protocol.

However, for those interested in this, see our old vendor protocol docs.

Resources