license: remove FSF postal address from boiler plate license text
[libsigrokdecode.git] / decoders / usb_signalling / __init__.py
1 ##
2 ## This file is part of the libsigrokdecode project.
3 ##
4 ## Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5 ##
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 of the License, or
9 ## (at your option) any later version.
10 ##
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 ## GNU General Public License for more details.
15 ##
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
18 ##
19
20 '''
21 This PD decodes the USB (low-speed and full-speed) signalling protocol.
22
23 Electrical/signalling layer (USB spec, chapter 7):
24
25 USB signalling consists of two signal lines, both driven at 3.3V
26 logic levels. The signals are DP (D+) and DM (D-), and normally operate in
27 differential mode.
28
29 Low-speed: The state where DP=1,DM=0 is K, the state DP=0,DM=1 is J.
30 Full-speed: The state where DP=1,DM=0 is J, the state DP=0,DM=1 is K.
31
32 A state SE0 is defined where DP=DM=0. This common mode signal is used to
33 signal a reset or end of packet (EOP). A state SE1 is defined where DP=DM=1.
34
35 Data transmitted on the USB is encoded with NRZI. A transition from J to K
36 or vice-versa indicates a logic 0, while no transition indicates a logic 1.
37 If 6 ones are transmitted consecutively, a zero is inserted to force a
38 transition. This is known as bit stuffing.
39
40 Data is transferred at a rate of 1.5Mbit/s (low-speed) / 12Mbit/s (full-speed).
41
42 The SE0 transmitted to signal an end-of-packet is two bit intervals long
43 (low-speed: 1.25uS - 1.50uS, full-speed: 160ns - 175ns).
44
45 Details:
46 https://en.wikipedia.org/wiki/USB
47 http://www.usb.org/developers/docs/
48 '''
49
50 from .pd import Decoder