Compare commits
70 Commits
master
...
usb-microb
Author | SHA1 | Date |
---|---|---|
King Kévin | 60e731d591 | |
King Kévin | 539f903625 | |
King Kévin | 68950ead0b | |
King Kévin | 01a2519c08 | |
King Kévin | d4547b78b5 | |
King Kévin | 975e65e72e | |
King Kévin | 8c748a3d89 | |
King Kévin | 1fae9ec7cd | |
King Kévin | e8cb0beeed | |
King Kévin | 661f03df74 | |
King Kévin | 1a9cf6d834 | |
King Kévin | c19fabed47 | |
King Kévin | 3c021ad719 | |
King Kévin | fb25dec0ad | |
King Kévin | 2d0995aa4b | |
King Kévin | ba78d751f7 | |
King Kévin | f226074e06 | |
King Kévin | a525f9a605 | |
King Kévin | 5ff2d0f0f9 | |
King Kévin | 2f1486b439 | |
King Kévin | d0bb63cccc | |
King Kévin | f3b9250f5a | |
King Kévin | cfa4f5a5b3 | |
King Kévin | 1ca3b8e8f1 | |
King Kévin | c7b4f748af | |
King Kévin | f83e7c2865 | |
King Kévin | e316945b24 | |
King Kévin | bb02e5cb39 | |
King Kévin | e75bcc0de2 | |
King Kévin | fb7b625e2d | |
King Kévin | 5e9d0ab5bb | |
King Kévin | dcbb170dd3 | |
King Kévin | df16dc3635 | |
King Kévin | 137e3ecaf9 | |
King Kévin | e59af54470 | |
King Kévin | ff7930ffb9 | |
King Kévin | e38ab1aea0 | |
King Kévin | c0100caab4 | |
King Kévin | 4fc12b9dfe | |
King Kévin | 9bc8ff5e5d | |
King Kévin | 5e95074149 | |
King Kévin | 9e7ea3eace | |
King Kévin | 984f8ae930 | |
King Kévin | b589acb8ae | |
King Kévin | 3e238fa988 | |
King Kévin | e4a9349ca1 | |
King Kévin | 694e17d5a9 | |
King Kévin | f656806680 | |
King Kévin | 11b3a090f4 | |
King Kévin | 7056147bc7 | |
King Kévin | f84b41576d | |
King Kévin | cb325dcab7 | |
King Kévin | 868d457ac8 | |
King Kévin | 251a985763 | |
King Kévin | ed6b0aa2fb | |
King Kévin | acd9966ea0 | |
King Kévin | b83b9ea22d | |
King Kévin | 5fe4b68e2e | |
King Kévin | fc120ff964 | |
King Kévin | 559fdffa68 | |
King Kévin | 5e6b3d5b5b | |
King Kévin | 248ed368f6 | |
King Kévin | 01dfef3ede | |
King Kévin | 2931753e5f | |
King Kévin | 07f98bf5cf | |
King Kévin | 914cb369cf | |
King Kévin | 7435eb9b42 | |
King Kévin | a99eb8663f | |
King Kévin | fff6b6a83c | |
King Kévin | 7e11f35812 |
|
@ -1,3 +1,6 @@
|
|||
[submodule "library"]
|
||||
path = library
|
||||
url = https://git.cuvoodoo.info/kingkevin/qeda_library
|
||||
[submodule "firmware/libopencm3"]
|
||||
path = firmware/libopencm3
|
||||
url = https://github.com/libopencm3/libopencm3
|
||||
|
|
17
.qeda.yaml
17
.qeda.yaml
|
@ -1,8 +1,6 @@
|
|||
config:
|
||||
nodate: true
|
||||
output: kicad7
|
||||
symbol:
|
||||
pinIcon: false
|
||||
pattern:
|
||||
densityLevel: 'N'
|
||||
lineWidth:
|
||||
|
@ -10,7 +8,22 @@ config:
|
|||
polarityMark: none
|
||||
preferManufacturer: false
|
||||
smoothPadCorners: false
|
||||
symbol:
|
||||
pinIcon: false
|
||||
library:
|
||||
- resistor/r0603
|
||||
- capacitor/c0603
|
||||
- diode/led0805
|
||||
- connector/usb-c_xkb_u262-24xn-4bv60
|
||||
- connector/usb-micro-b-2.0_xkb_u254-051n
|
||||
- connector/usb-a-3.0_xkb_u231-09xn-4blra00
|
||||
- diode/led0603
|
||||
- connector/usb-c_hro_type-c-31-m-17
|
||||
- connector/battery_my-2032-12
|
||||
- transistor/pmos_bss84
|
||||
- transistor/nmos_bss138
|
||||
- vreg/fuse_1206sfh
|
||||
- vreg/ldo_torex_xc6206@mr
|
||||
- diode/schottky@sod323
|
||||
- mcu/st_stm32f030@lqfp48
|
||||
- mechanical/smd-button_tx-1187a
|
||||
|
|
37
CHANGELOG.md
37
CHANGELOG.md
|
@ -0,0 +1,37 @@
|
|||
TODO:
|
||||
|
||||
- make current draw zero when no cable is connected
|
||||
|
||||
v1
|
||||
==
|
||||
|
||||
changes:
|
||||
|
||||
- make capabilities more compact
|
||||
- add interpretation purpose part
|
||||
- add button for battery usage
|
||||
- add connector presence test
|
||||
|
||||
fixes:
|
||||
|
||||
- BC test. I'm not sure what I had in mind but there were too errors: micro-B D- and D+ are shorted on the board (thus no way to detect the short in the plug), D-/D+ on the test would be left floating on plug with BC (thus would not turn the LED on)
|
||||
- VBUS test. On cables with ground wire, but no VBUS wire (such as A-C cable with not all GND or VBUS pin in C plug), the power ground would pull down VBUS through LED D1A for host A just enough to switch on Q1, lighting up LED D1C LED for host C
|
||||
- CC test: only for *-C cable. C to micro-B would also trigger it
|
||||
- and improve a lot of other tests
|
||||
|
||||
issues:
|
||||
|
||||
|
||||
v0
|
||||
==
|
||||
|
||||
first prototype containing testers for USB A, micro-B, and C.
|
||||
not tested yet.
|
||||
only shows the features, and does not interpret them.
|
||||
|
||||
issues:
|
||||
|
||||
- BC test is wrong
|
||||
- shield is detected although there is none (not sure why)
|
||||
- Rp is detected although there is none (not sure why)
|
||||
- red LEDs is too bright (1 kOhm current limiting resistor is too weak, 5.1k is better)
|
|
@ -6,7 +6,7 @@ requirements
|
|||
to be able to generate the outputs, you need following software:
|
||||
|
||||
- [QEDA](http://qeda.org/): to generate footprints for the parts
|
||||
- [KiCad v8](https://www.kicad.org/): EDA software used for schematic capture and board layout
|
||||
- [KiCad v7](https://www.kicad.org/): EDA software used for schematic capture and board layout
|
||||
- [PcbDraw](https://github.com/yaqwsx/PcbDraw): to generate board layout rendering
|
||||
- [KiKit](https://github.com/yaqwsx/KiKit): to generate fabrications files (Gerber, Excellon)
|
||||
- [KiBoM](https://github.com/SchrodingersGat/KiBoM): to generate Bill of Material (CSV)
|
||||
|
|
36
Makefile
36
Makefile
|
@ -1,6 +1,6 @@
|
|||
# project file name (use for schematic and board layout)
|
||||
NAME ?= template
|
||||
SUBSHEET ?=
|
||||
NAME ?= usb-microbc_cable_tester
|
||||
SUBSHEET ?= usb-microbc_cable_tester-mcu
|
||||
# path to KiCad CLI
|
||||
KICAD = kicad-cli
|
||||
# path to qeda
|
||||
|
@ -33,12 +33,10 @@ VERSIONED_SHEET = $(foreach SHEET,$(NAME) $(SUBSHEET),$(SHEET).versioned.kicad_s
|
|||
FABRICATION_DIR := fabrication
|
||||
IBOM := ${FABRICATION_DIR}/ibom.html
|
||||
|
||||
all: $(VERSIONED_SHEET) ${NAME}.sch.pdf ${NAME}.bom.csv render fab
|
||||
all: $(VERSIONED_SHEET) ${NAME}.sch.pdf ${NAME}.brd-top.png ${NAME}.brd-bot.png ${NAME}.bom.csv ${NAME}.3d.step fab
|
||||
|
||||
fab: ${FABRICATION_DIR} ${IBOM}
|
||||
|
||||
render: ${NAME}.brd-top.png ${NAME}.brd-bot.png ${NAME}.brd-top.svg ${NAME}.brd-bot.svg ${NAME}.3d.step
|
||||
|
||||
# generate fabrication files (gerbers/drill/BoM/PnP)
|
||||
${FABRICATION_DIR}: ${NAME}.versioned.kicad_sch ${NAME}.versioned.kicad_pcb
|
||||
kikit fab jlcpcb --no-drc --assembly --field JLCPCB,LCSC --schematic $^ $@
|
||||
|
@ -70,14 +68,6 @@ lib:
|
|||
%.brd-bot.png: %.versioned.kicad_pcb
|
||||
pcbdraw plot --silent --no-components --dpi 600 --side back $< $@
|
||||
|
||||
# generate render from layout (top side)
|
||||
%.brd-top.svg: %.versioned.kicad_pcb
|
||||
$(KICAD) pcb export svg --layers F.Cu,F.Paste,F.Silkscreen,Edge.Cuts --page-size-mode 2 --exclude-drawing-sheet --output $@ $<
|
||||
|
||||
# generate render from layout (bottom side)
|
||||
%.brd-bot.svg: %.versioned.kicad_pcb
|
||||
$(KICAD) pcb export svg --layers B.Cu,B.Paste,B.Silkscreen,Edge.Cuts --mirror --page-size-mode 2 --exclude-drawing-sheet --output $@ $<
|
||||
|
||||
# export Bill of Material (as CSV)
|
||||
%.bom.xml: %.versioned.kicad_sch %.versioned.kicad_pro
|
||||
$(KICAD) sch export python-bom --output $@ $<
|
||||
|
@ -91,22 +81,20 @@ lib:
|
|||
$(KIBOM) $< $@
|
||||
|
||||
# generate panel
|
||||
PANEL_DIR := panel_fab
|
||||
|
||||
panel: panel.kicad_pcb panel.brd-top.svg panel.brd-bot.svg panel.brd-top.png panel.brd-bot.png ${PANEL_DIR}
|
||||
|
||||
panel.kicad_pcb: ${NAME}.versioned.kicad_pcb ${NAME}.versioned.kicad_pro ${NAME}.versioned.kicad_sch panel.versioned.json
|
||||
kikit panelize -p panel.versioned.json ${NAME}.versioned.kicad_pcb $@
|
||||
PANEL_DIR := panel
|
||||
panel: panel.kicad_pcb
|
||||
panel.kicad_pcb: ${NAME}.versioned.kicad_pcb ${NAME}.versioned.kicad_pro ${NAME}.versioned.kicad_sch ${NAME}.versioned.json
|
||||
kikit panelize -p ${NAME}.versioned.json ${NAME}.versioned.kicad_pcb $@
|
||||
sed --in-place 's/\"missing_courtyard\": \"warning\"/\"missing_courtyard\": \"ignore\"/g' $(patsubst %.kicad_pcb,%.kicad_pro,$@) # the mouse bites don't have a courtyard
|
||||
|
||||
${PANEL_DIR}: ${NAME}.versioned.kicad_sch panel.kicad_pcb
|
||||
kikit fab jlcpcb --assembly --missingError --field JLCPCB,LCSC --schematic $^ $@
|
||||
kikit fab jlcpcb --assembly --missingError --field JLCPCB,LCSC --schematic ${NAME}.versioned.kicad_sch $@ ${PANEL_DIR}
|
||||
pcbdraw --silent $@ --dpi 600 panel.brd-top.png
|
||||
pcbdraw --silent $@ --dpi 600 --back panel.brd-bot.png
|
||||
|
||||
clean:
|
||||
rm -f $(foreach EXT,$(VERSIONED_EXT),${NAME}.versioned.$(EXT))
|
||||
rm -f ${NAME}.sch.pdf ${NAME}.brd-top.png ${NAME}.brd-bot.png ${NAME}.brd-top.svg ${NAME}.brd-bot.svg ${NAME}.versioned.xml ${NAME}.bom.csv
|
||||
rm -f ${NAME}.sch.pdf ${NAME}.brd-top.png ${NAME}.brd-bot.png ${NAME}.versioned.xml ${NAME}.bom.csv
|
||||
rm -f ${NAME}.versioned.kicad_prl ${NAME}.versioned.kicad_pro-bak ${NAME}.versioned.xml ${NAME}.versioned.csv
|
||||
rm -f ${IBOM}
|
||||
rm -rf ${FABRICATION_DIR}
|
||||
rm -f panel.versioned.json panel.kicad_pcb panel.kicad_pro panel.brd-top.svg panel.brd-bot.svg panel.brd-top.png panel.brd-bot.png
|
||||
rm -f panel.kicad_pcb panel.kicad_pro
|
||||
rm -rf ${PANEL_DIR}
|
||||
|
|
151
README.md
151
README.md
|
@ -1,7 +1,152 @@
|
|||
these are the hardware design files for **insert project name here**.
|
||||
The USB micro-B and C cable tester identifies capabilities supported by USB cables and deduces their purpose.
|
||||
It helps figuring out if a USB cable is for charging or to transfer data, and at which speed.
|
||||
It supports type A to micro-B, A to C, and C to C USB cables.
|
||||
|
||||
purpose
|
||||
=======
|
||||
<img src="picture/front.webp" title="front" height="250"/>
|
||||
<img src="picture/back.webp" title="back" height="250"/>
|
||||
|
||||
usage
|
||||
=====
|
||||
|
||||
- ensure the tester has a non-empty battery in the CR2032/2025 slot, or is externally powered through the USB power port
|
||||
- plug one end of the cable in one of the host ports
|
||||
- plug the other end of the cable in one of the devices ports
|
||||
- when using a battery, press on the BAT ON button
|
||||
- the tester will identify the cable's capabilities, on the left side
|
||||
- the tester will then show the cable's purpose, on the right side
|
||||
|
||||
Once I know it's purpose, I mark the cables with a letter:
|
||||
|
||||
- USB A to micro-B only with ground and VBUS wires, limiting power transfer to 0.5 since they can't indicate battery charge: **P**
|
||||
|
||||
<img src="picture/a-b-p.webp" width="300"/>
|
||||
|
||||
- USB A to micro-B, with data line shorted internally to indicate 1.5A battery charge (even when not sure the host supports it): **C**
|
||||
|
||||
<img src="picture/a-b-c.webp" width="300"/>
|
||||
|
||||
- USB A to micro-B with data wires, but error prone since not shielded (sufficient for low speed): **D**
|
||||
|
||||
<img src="picture/a-b-d.webp" width="300"/>
|
||||
|
||||
- USB A to micro-B with shielded data wires (good for high speed): **S**
|
||||
|
||||
<img src="picture/a-b-s.webp" width="300"/>
|
||||
|
||||
- USB A to C without data lines but battery charge indication: **C**
|
||||
|
||||
<img src="picture/a-c-c.webp" width="300"/>
|
||||
|
||||
- USB A to C with unshielded data lines: **D**
|
||||
|
||||
<img src="picture/a-c-d.webp" width="300"/>
|
||||
|
||||
- USB A to C with SuperSpeed data lines, and shielded: **3**
|
||||
|
||||
<img src="picture/a-c-3.webp" width="300"/>
|
||||
|
||||
- USB A to C with SuperSpeed data lines, but unshielded (thus faulty): **D**
|
||||
|
||||
<img src="picture/a-c-sd.webp" width="300"/>
|
||||
|
||||
- USB C to C with shielded data lines: **S**
|
||||
|
||||
<img src="picture/c-c-s.webp" width="300"/>
|
||||
|
||||
- USB C to C with electronic marking allowing 5A charging: **C**
|
||||
|
||||
<img src="picture/c-c-c.webp" width="300"/>
|
||||
|
||||
- USB C to C with all features: **F**
|
||||
|
||||
<img src="picture/c-c-f.webp" width="300"/>
|
||||
|
||||
The tester can detect electronically marked C to C cables.
|
||||
Often they are present (and required) in cables allowing 5A/100W charging.
|
||||
But to be sure, one should read the capabilities from the chip, which is not supported by the tester.
|
||||
Full Feature C to C cable also require electronical marking, but could only support 3A charging.
|
||||
Because of that the 3A and 5A indicators are on at the same time (when the marking can be just for the features).
|
||||
|
||||
To understand further the capabilities and purpose of a cable, I recommend reading the USB specification, mainly the one for the [type-C connector](https://www.usb.org/document-library/usb-type-cr-cable-and-connector-specification-release-23).
|
||||
|
||||
report
|
||||
------
|
||||
|
||||
There is a UART output on the debug port.
|
||||
The analysis of the capabilities to the purpose is periodically output on it.
|
||||
You can connect to it and view it using the 115200 8N1 baud rate.
|
||||
|
||||
firmware
|
||||
--------
|
||||
|
||||
You can flash or update the firmware using the SWD signals on the debug port, of also use the UART signals and the bootloader.
|
||||
To start the bootloader, press and hold the BL button while shortly pressing the RST button.
|
||||
You can then use [stm32flash](https://github.com/stm32duino/stm32flash):
|
||||
|
||||
~~~
|
||||
stm32flash -w binray.hex -v /dev/ttyACM0
|
||||
~~~
|
||||
|
||||
The compiled binary is available in the release archives.
|
||||
The source code of the firmware is in the `firmware` folder.
|
||||
|
||||
design choice
|
||||
=============
|
||||
|
||||
features
|
||||
--------
|
||||
|
||||
do:
|
||||
|
||||
- USB micro-B: still wide-spread and popular for charging devices
|
||||
- USB type-A: still the de-facto host plug
|
||||
- USB type-C: becoming the standard for battery operated devices
|
||||
- C to C: often used for high power charging of phones and laptops
|
||||
- battery operated: it's a very simple device, and this avoids needing to require external power
|
||||
- power port: in case you have no battery or it runs out
|
||||
- USB 3.0: because it is hard to identify if C-C cable support SuperSpeed
|
||||
- purpose: deduce from capabilities for users not knowledgable in USB cables
|
||||
|
||||
don't:
|
||||
|
||||
- small: no need to build it as compact as possible
|
||||
- A to micro-B 3.0: the connectors that support it are obvious, and it's rare they are used for anything else than Super-Speed transfer (plus they are less common or problematic)
|
||||
- Power Delivery capabilities: this requires complex host software communicating with the eMarker chip in the cable
|
||||
- OTG: even if detecting this functionality is easy, micro-B OTG adapters are not popular anymore
|
||||
- impedance: only the presence of wires is tester, not their impedance
|
||||
|
||||
mode of operation
|
||||
-----------------
|
||||
|
||||
Most of the tests just verify if the wires corresponding to capabilities are present in the cable.
|
||||
Some additional tests verify the resistances in the plugs.
|
||||
For more details, check the schematic, and refer to [type-C specification](https://www.usb.org/document-library/usb-type-cr-cable-and-connector-specification-release-23).
|
||||
|
||||
The left side identifies the capabilities.
|
||||
Based on that, a micro-controller (MCU) will map the combination into a purpose on the right side.
|
||||
The left side is independent of the MCU and right side.
|
||||
|
||||
limitation
|
||||
----------
|
||||
|
||||
The tester does not:
|
||||
|
||||
- verify the resistance of wires, particularly the power ones
|
||||
- verify the impedance of wires, particularly the differential ones
|
||||
- verify if the shield(s) is more than just a wire
|
||||
- read out capabilities from electronically marked cables
|
||||
- guarantee USB cable compliance or conformity, as this is [very complex](https://www.usb.org/documents?search=&category%5B%5D=49&type%5B%5D=56&tid_2%5B%5D=41&items_per_page=50)
|
||||
|
||||
You can short the two pads marked BAT ON next to the battery with a solder blob.
|
||||
This will always power the board and does not require you to press on the BAT ON button to do the test, like when powering through the USB POWER port.
|
||||
But this will continuously drain 0.7 mA, emptying a CR2032 coin cell in 24 days.
|
||||
|
||||
alternatives
|
||||
------------
|
||||
|
||||
- [USB micro-B cable tester](https://www.cuvoodoo.info/cuvoodoo-gadget-micro-usb-cable-tester-v2/): only does micro-B cables
|
||||
- [USB A-C cable tester](https://www.cuvoodoo.info/cuvoodoo-gadget-usb-a-to-usb-c-cable-tester-v1/): only does USB type A to type C cables
|
||||
- [USB C-C cable tester](https://www.cuvoodoo.info/cuvoodoo-gadget-usb-c-cable-tester-v2/): only does USB type C to type C cables
|
||||
- [DT3 Data Cable Detection Board](https://www.aliexpress.com/item/1005006302832038.html): does not check shield, battery charging, USB 3.0
|
||||
- [USB Cable Checker 2](https://www.tindie.com/products/bittradeone/usb-cable-checker-2-assembled/): too complex and expensive
|
||||
- [USB Cable Tester](https://github.com/alvarop/usb_c_cable_tester): only for USB-C and you have to understand and interpret the signals
|
||||
|
|
|
@ -0,0 +1,7 @@
|
|||
*.bin
|
||||
*.hex
|
||||
*.elf
|
||||
*.ld
|
||||
*.o
|
||||
*.d
|
||||
*.bak
|
|
@ -0,0 +1,3 @@
|
|||
[submodule "libopencm3"]
|
||||
path = libopencm3
|
||||
url = https://github.com/libopencm3/libopencm3
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
|
@ -0,0 +1,42 @@
|
|||
DEVICE = stm32f030c8t6
|
||||
OPENCM3_DIR =./libopencm3
|
||||
OBJS += main.o
|
||||
|
||||
CFLAGS += -Os -ggdb3 -specs=nosys.specs
|
||||
CPPFLAGS += -MD
|
||||
LDFLAGS += -static -nostartfiles -specs=nosys.specs
|
||||
LDLIBS += -Wl,--start-group -lc -lgcc -lnosys -Wl,--end-group
|
||||
|
||||
OOCD ?= openocd
|
||||
OOCD_INTERFACE ?= cmsis-dap
|
||||
OOCD_TARGET ?= stm32f0x
|
||||
|
||||
include $(OPENCM3_DIR)/mk/genlink-config.mk
|
||||
include $(OPENCM3_DIR)/mk/gcc-config.mk
|
||||
|
||||
.PHONY: clean all
|
||||
|
||||
all: binary.elf binary.hex
|
||||
|
||||
clean:
|
||||
$(Q)$(RM) -rf binary.* *.o
|
||||
|
||||
bl: binary.hex
|
||||
stm32flash -w $< -v /dev/ttyACM0
|
||||
|
||||
flash: binary.elf
|
||||
$(OOCD) -f interface/$(OOCD_INTERFACE).cfg \
|
||||
-f target/$(OOCD_TARGET).cfg \
|
||||
-c "program $< verify reset exit"
|
||||
|
||||
debug: binary.elf
|
||||
$(GDB) --eval-command='target remote | $(OOCD) --file interface/$(OOCD_INTERFACE).cfg --command "transport select swd" --file target/$(OOCD_TARGET).cfg --command "gdb_port pipe; log_output /dev/null; init"' $<
|
||||
|
||||
include $(OPENCM3_DIR)/mk/genlink-rules.mk
|
||||
include $(OPENCM3_DIR)/mk/gcc-rules.mk
|
||||
|
||||
$(OPENCM3_DIR)/lib/lib$(LIBNAME).a:
|
||||
ifeq (,$(wildcard $@))
|
||||
$(warning $(LIBNAME).a not found, attempting to rebuild in $(OPENCM3_DIR))
|
||||
$(MAKE) -C $(OPENCM3_DIR)
|
||||
endif
|
|
@ -0,0 +1 @@
|
|||
Subproject commit bb4c5d7324554fe7a3137bfbcf3b5200ee2648fa
|
|
@ -0,0 +1,745 @@
|
|||
/* SPDX-License-Identifier: GPL-3.0-or-later
|
||||
* Copyright 2024 King Kévin <kingkevin@cuvoodoo.info>
|
||||
*/
|
||||
#include <libopencm3/stm32/rcc.h>
|
||||
#include <libopencm3/stm32/gpio.h>
|
||||
#include <libopencm3/stm32/usart.h>
|
||||
#include <libopencm3/stm32/timer.h>
|
||||
#include <libopencm3/stm32/adc.h> // ADC utilities
|
||||
#include <libopencm3/cm3/nvic.h>
|
||||
|
||||
#include <stdio.h>
|
||||
#include <errno.h>
|
||||
#include <sys/stat.h>
|
||||
|
||||
// get the length of an array
|
||||
#define LENGTH(x) (sizeof(x) / sizeof((x)[0]))
|
||||
// print debug messages
|
||||
#define DEBUG (false)
|
||||
// duration to wait for pull-up/down (in cycles)
|
||||
#define PULL_DURATION (100U)
|
||||
|
||||
enum io_name {
|
||||
// inputs
|
||||
GNDA, // on host side, pulled high
|
||||
GNDC, // on host side, pulled high
|
||||
VBUSB, // on device side, pulled low
|
||||
VBUSC, // on device side, pulled low
|
||||
HDM, // pulled high when no wire, pulled low when wire
|
||||
HDP, // pulled low when no wire, high when wire
|
||||
DDM, // pulled low when not shorted, high when shorted
|
||||
SSP, // 3V3 on A when SS wires present, sources LED, not pulled
|
||||
SSM, // GND on A when SS wires present, sinks LED, not pulled
|
||||
SS1, // GND on C when SS wires present, sinks LED, not pulled
|
||||
SS2, // GND on C when SS wires present, sinks LED, not pulled
|
||||
HCC1, // pulled high
|
||||
HCC2, // pulled high
|
||||
DCC1, // pull high when CC wire present, weakly pulled low
|
||||
DCC2, // pull high when CC wire present, weakly pulled low
|
||||
SBU, // GND on C when SBU wires present, sinks LED, not pulled
|
||||
HSH, // GND when host-C present, pulled high
|
||||
DSH, // GND when device-C present, sinks LED, no pulled
|
||||
BSH, // pull high when *-B shield present, weakly pulled low (to cable ground)
|
||||
// button input
|
||||
BUTTON,
|
||||
// outputs
|
||||
LEDX,
|
||||
LEDY,
|
||||
LEDZ,
|
||||
LED1,
|
||||
LED2,
|
||||
LED3,
|
||||
LED4,
|
||||
IO_MAX
|
||||
};
|
||||
|
||||
static const uint32_t io_port[IO_MAX] = {
|
||||
[GNDA] = GPIOC,
|
||||
[GNDC] = GPIOC,
|
||||
[VBUSB] = GPIOB,
|
||||
[VBUSC] = GPIOB,
|
||||
[HDM] = GPIOF,
|
||||
[HDP] = GPIOF,
|
||||
[DDM] = GPIOC,
|
||||
[SSP] = GPIOB,
|
||||
[SSM] = GPIOB,
|
||||
[SS1] = GPIOB,
|
||||
[SS2] = GPIOB,
|
||||
[HCC1] = GPIOA,
|
||||
[HCC2] = GPIOA,
|
||||
[DCC1] = GPIOA,
|
||||
[DCC2] = GPIOA,
|
||||
[SBU] = GPIOB,
|
||||
[HSH] = GPIOA,
|
||||
[DSH] = GPIOA,
|
||||
[BSH] = GPIOA,
|
||||
[BUTTON] = GPIOB,
|
||||
[LEDX] = GPIOB,
|
||||
[LEDY] = GPIOB,
|
||||
[LEDZ] = GPIOB,
|
||||
[LED1] = GPIOB,
|
||||
[LED2] = GPIOB,
|
||||
[LED3] = GPIOB,
|
||||
[LED4] = GPIOB,
|
||||
};
|
||||
|
||||
static const uint16_t io_pin[IO_MAX] = {
|
||||
[GNDA] = GPIO13,
|
||||
[GNDC] = GPIO14,
|
||||
[VBUSB] = GPIO8,
|
||||
[VBUSC] = GPIO9,
|
||||
[HDM] = GPIO1,
|
||||
[HDP] = GPIO0,
|
||||
[DDM] = GPIO15,
|
||||
[SSP] = GPIO0,
|
||||
[SSM] = GPIO1,
|
||||
[SS1] = GPIO2,
|
||||
[SS2] = GPIO10,
|
||||
[HCC1] = GPIO3,
|
||||
[HCC2] = GPIO4,
|
||||
[DCC1] = GPIO2,
|
||||
[DCC2] = GPIO1,
|
||||
[SBU] = GPIO11,
|
||||
[HSH] = GPIO7,
|
||||
[DSH] = GPIO6,
|
||||
[BSH] = GPIO5,
|
||||
[BUTTON] = GPIO7,
|
||||
[LEDX] = GPIO5,
|
||||
[LEDY] = GPIO4,
|
||||
[LEDZ] = GPIO3,
|
||||
[LED1] = GPIO12,
|
||||
[LED2] = GPIO13,
|
||||
[LED3] = GPIO14,
|
||||
[LED4] = GPIO15,
|
||||
};
|
||||
|
||||
// if we should do a pull test
|
||||
// the capability tests use current to power LEDs, we need to check using voltage
|
||||
static const uint16_t io_pull[BUTTON] = {
|
||||
[GNDA] = false,
|
||||
[GNDC] = false,
|
||||
[VBUSB] = false,
|
||||
[VBUSC] = false,
|
||||
[HDM] = false,
|
||||
[HDP] = false,
|
||||
[DDM] = false,
|
||||
[SSP] = true, // capability current test
|
||||
[SSM] = true, // capability current test
|
||||
[SS1] = true, // capability current test
|
||||
[SS2] = true, // capability current test
|
||||
[HCC1] = false,
|
||||
[HCC2] = false,
|
||||
[DCC1] = false,
|
||||
[DCC2] = false,
|
||||
[SBU] = true, // capability current test
|
||||
[HSH] = false,
|
||||
[DSH] = true, // capability current test
|
||||
[BSH] = false,
|
||||
// LEDs are not pulls
|
||||
};
|
||||
|
||||
static bool io_pn[BUTTON] = {false}; // if up when not pulled
|
||||
static bool io_pu[BUTTON] = {false}; // if up when pulled up
|
||||
static bool io_pd[BUTTON] = {false}; // if up when pulled down
|
||||
|
||||
uint16_t ledx = 0; // which LEDs to set on row X
|
||||
uint16_t ledy = 0; // which LEDs to set on row Y
|
||||
uint16_t ledz = 0; // which LEDs to set on row Z
|
||||
|
||||
// voltages to convert
|
||||
const uint8_t channels[] = { // must be ordered by number
|
||||
0, // VCC, PA0, ADC_IN0
|
||||
1, // DCC2, PA1, ADC_IN1
|
||||
2, // DCC1, PA2, ADC_IN2
|
||||
3, // HCC1, PA3, ADC_IN3
|
||||
4, // HCC2, PA4, ADC_IN4
|
||||
ADC_CHANNEL_VREF, // internal voltage reference
|
||||
};
|
||||
|
||||
enum fault {
|
||||
FAULT_VBUS_NOT_GND,
|
||||
FAULT_GND_NOT_VBUS,
|
||||
FAULT_DM_CONNECT,
|
||||
FAULT_HOST_DATA_PULLED,
|
||||
FAULT_DATA_NOT_GND,
|
||||
FAULT_DATA_NOT_VBUS,
|
||||
FAULT_SS_NOT_GND,
|
||||
FAULT_SS_NOT_VBUS,
|
||||
FAULT_SS_NOT_SHIELD,
|
||||
FAULT_SS_NOT_DATA,
|
||||
FAULT_GND_DRAIN,
|
||||
FAULT_CC_NOT_DC,
|
||||
FAULT_DC_NOT_CCRP,
|
||||
FAULT_CC_NOT_CC,
|
||||
FAULT_SBU_NOT_HC,
|
||||
FAULT_SBU_NOT_DC,
|
||||
FAULT_RA_NOT_HA,
|
||||
FAULT_RA_NOT_DC,
|
||||
FAULT_AC_NOT_RP,
|
||||
FAULT_RP_NOT_AC,
|
||||
FAULT_RD_NOT_DB,
|
||||
FAULT_MAX
|
||||
};
|
||||
|
||||
static const char* faults[FAULT_MAX] = {
|
||||
[FAULT_VBUS_NOT_GND] = "VBUS present, but GND missing",
|
||||
[FAULT_GND_NOT_VBUS] = "GND present, but VBUS missing",
|
||||
[FAULT_DM_CONNECT] = "host and device D- not inter-connected",
|
||||
[FAULT_HOST_DATA_PULLED] = "host data lines are not floating",
|
||||
[FAULT_DATA_NOT_GND] = "data lines present, but GND missing",
|
||||
[FAULT_DATA_NOT_VBUS] = "data lines present, but VBUS missing",
|
||||
[FAULT_SS_NOT_GND] = "SuperSpeed data lines present, but GND missing",
|
||||
[FAULT_SS_NOT_VBUS] = "SuperSpeed data lines present, but VBUS missing",
|
||||
[FAULT_SS_NOT_SHIELD] = "SuperSpeed data lines present, but shield missing",
|
||||
[FAULT_SS_NOT_DATA] = "SuperSpeed data lines present, but USB 2.0 data lines missing",
|
||||
[FAULT_GND_DRAIN] = "GND_DRAIN not connected to ground",
|
||||
[FAULT_CC_NOT_DC] = "Rp/CC line present, but device C missing",
|
||||
[FAULT_DC_NOT_CCRP] = "device C present, but Rp/CC line missing",
|
||||
[FAULT_CC_NOT_CC] = "C-C cable, but CC line missing",
|
||||
[FAULT_SBU_NOT_HC] = "SBU present, but host C missing",
|
||||
[FAULT_SBU_NOT_DC] = "SBU present, but device C missing",
|
||||
[FAULT_RA_NOT_HA] = "Ra detected, but host A missing",
|
||||
[FAULT_RA_NOT_DC] = "Ra detected, but device C missing",
|
||||
[FAULT_AC_NOT_RP] = "A-C cable, but Rp missing",
|
||||
[FAULT_RP_NOT_AC] = "Rp detected, but not A-C cable",
|
||||
[FAULT_RD_NOT_DB] = "Rd detected, but not C-microB cable",
|
||||
};
|
||||
|
||||
enum cc_rx {
|
||||
R_UNKNOWN, // everything else
|
||||
R_OPEN, // pulled by board, no resistor in cable, no CC wire
|
||||
R_5K1, // pulled by board, no resistor in cable, CC wire
|
||||
RA_1K, // Ra in cable to indicate eMarker
|
||||
RD_5K1, // 5.1k pull down Rd resistor in host C to indicate device
|
||||
RP_56K, // 56k pull up Rp resistor in device C to indicate host current capable of 0.5-0.8A
|
||||
RP_22K, // 22k pull up Rp resistor in device C to indicate host current capable of 1.5A
|
||||
RP_10K, // 10k pull up Rp resistor in device C to indicate host current capable of 3.0A
|
||||
R_MAX,
|
||||
};
|
||||
|
||||
static const char* cc_rx_str[R_MAX] = {
|
||||
[R_UNKNOWN] = "?",
|
||||
[R_OPEN] = "open",
|
||||
[R_5K1] = "C-C",
|
||||
[RA_1K] = "Ra",
|
||||
[RD_5K1] = "Rd",
|
||||
[RP_56K] = "Rp 56k",
|
||||
[RP_22K] = "Rp 22k",
|
||||
[RP_10K] = "Rp 10k",
|
||||
};
|
||||
|
||||
// measured and set by meas_rx
|
||||
static enum cc_rx cc_r[4]; // HCC1, HCC2, DCC1, DCC2
|
||||
|
||||
__attribute__((weak)) int _read(int file, char *ptr, int len){ return -1; }
|
||||
int _close(int file){ return -1; }
|
||||
int _fstat(int file, struct stat *st){ st->st_mode = S_IFCHR; return 0; }
|
||||
int _isatty(int file){ return 1; }
|
||||
int _lseek(int file, int ptr, int dir){ return 0; }
|
||||
int _getpid(){ return -1; }
|
||||
int _kill(int pid, int sig){ return -1; }
|
||||
|
||||
int _write(int file, char *ptr, int len)
|
||||
{
|
||||
int i;
|
||||
|
||||
if (file == 1) {
|
||||
for (i = 0; i < len; i++)
|
||||
usart_send_blocking(USART1, ptr[i]);
|
||||
return i;
|
||||
}
|
||||
|
||||
errno = EIO;
|
||||
return -1;
|
||||
}
|
||||
|
||||
static void usart_setup(void)
|
||||
{
|
||||
// enable clocks for USART
|
||||
rcc_periph_clock_enable(RCC_USART1);
|
||||
// setup GPIO pins for USART transmit
|
||||
gpio_mode_setup(GPIOA, GPIO_MODE_AF, GPIO_PUPD_NONE, GPIO9);
|
||||
// setup USART TX pin as alternate function
|
||||
gpio_set_af(GPIOA, GPIO_AF1, GPIO9);
|
||||
|
||||
// setup USART parameters
|
||||
usart_set_baudrate(USART1, 115200);
|
||||
usart_set_databits(USART1, 8);
|
||||
usart_set_parity(USART1, USART_PARITY_NONE);
|
||||
usart_set_stopbits(USART1, USART_CR2_STOPBITS_1);
|
||||
usart_set_mode(USART1, USART_MODE_TX);
|
||||
usart_set_flow_control(USART1, USART_FLOWCONTROL_NONE);
|
||||
usart_enable(USART1);
|
||||
}
|
||||
|
||||
static void gpio_setup(void)
|
||||
{
|
||||
// enable GPIO clock for inputs and LEDs
|
||||
rcc_periph_clock_enable(RCC_GPIOA);
|
||||
rcc_periph_clock_enable(RCC_GPIOB);
|
||||
rcc_periph_clock_enable(RCC_GPIOC);
|
||||
rcc_periph_clock_enable(RCC_GPIOF);
|
||||
|
||||
// ADC to measure Rp
|
||||
gpio_mode_setup(GPIOA, GPIO_MODE_ANALOG, GPIO_PUPD_NONE, GPIO0); // Vcc analog input
|
||||
rcc_periph_clock_enable(RCC_ADC1); // enable clock for ADC domain
|
||||
adc_power_off(ADC1); // switch off ADC while configuring it
|
||||
adc_set_clk_source(ADC1, ADC_CLKSOURCE_ADC);
|
||||
adc_set_right_aligned(ADC1); // ensure it is right aligned to get the actual value in the 16-bit register
|
||||
adc_disable_external_trigger_regular(ADC1);
|
||||
adc_enable_vrefint(); // enable internal voltage reference
|
||||
adc_set_operation_mode(ADC1, ADC_MODE_SCAN); // use scan mode do be able to go to next discontinuous subgroup of the regular sequence
|
||||
adc_enable_discontinuous_mode(ADC1); // use discontinuous mode (to go through all channels of the group, one after another)
|
||||
adc_set_single_conversion_mode(ADC1); // ensure continuous mode is not used (that's not the same as discontinuous)
|
||||
adc_set_sample_time_on_all_channels(ADC1, ADC_SMPTIME_071DOT5);
|
||||
adc_set_regular_sequence(ADC1, LENGTH(channels), (uint8_t*)channels); // set channel to convert
|
||||
adc_set_resolution(ADC1, ADC_RESOLUTION_12BIT);
|
||||
adc_disable_analog_watchdog(ADC1);
|
||||
adc_calibrate(ADC1);
|
||||
adc_power_on(ADC1); // switch on ADC
|
||||
|
||||
// setup GPIO pin for inputs
|
||||
for (uint8_t i = 0; i < LEDX; i++) {
|
||||
gpio_mode_setup(io_port[i], GPIO_MODE_INPUT, GPIO_PUPD_NONE, io_pin[i]);
|
||||
}
|
||||
|
||||
// setup GPIO pin for LEDs
|
||||
for (uint8_t i = LEDX; i < IO_MAX; i++) {
|
||||
gpio_clear(io_port[i], io_pin[i]); // switch off LED
|
||||
gpio_mode_setup(io_port[i], GPIO_MODE_OUTPUT, GPIO_PUPD_NONE, io_pin[i]); // set as output
|
||||
}
|
||||
|
||||
// test LEDs
|
||||
gpio_clear(io_port[LEDX], io_pin[LEDX] | io_pin[LEDY] | io_pin[LEDZ]); // disable all rows
|
||||
gpio_clear(io_port[LED1], io_pin[LED1] | io_pin[LED2] | io_pin[LED3] | io_pin[LED4]); // enable all columns
|
||||
gpio_set(io_port[LEDX], io_pin[LEDX]); // enable first row
|
||||
for (volatile uint32_t i = 0; i < 20000; i++);
|
||||
gpio_clear(io_port[LEDX], io_pin[LEDX]); // disable first row
|
||||
gpio_set(io_port[LEDY], io_pin[LEDY]); // enable second row
|
||||
for (volatile uint32_t i = 0; i < 20000; i++);
|
||||
gpio_clear(io_port[LEDY], io_pin[LEDY]); // disable second row
|
||||
gpio_set(io_port[LEDZ], io_pin[LEDZ]); // enable second row
|
||||
for (volatile uint32_t i = 0; i < 20000; i++);
|
||||
gpio_clear(io_port[LEDZ], io_pin[LEDZ]); // disable third row
|
||||
}
|
||||
|
||||
static void timer_setup(void)
|
||||
{
|
||||
// enable timer for LED matrix
|
||||
rcc_periph_clock_enable(RCC_TIM14); // enable clock for timer peripheral
|
||||
rcc_periph_reset_pulse(RST_TIM14); // reset timer state
|
||||
timer_set_mode(TIM14, TIM_CR1_CKD_CK_INT, TIM_CR1_CMS_EDGE, TIM_CR1_DIR_UP); // set timer mode, use undivided timer clock,edge alignment (simple count), and count up
|
||||
timer_set_prescaler(TIM14, 1); // set lowest speed to not flicker
|
||||
timer_set_period(TIM14, 15000); // hand tuned
|
||||
timer_clear_flag(TIM14, TIM_SR_UIF); // clear flag
|
||||