Compare commits

...

277 Commits

Author SHA1 Message Date
King Kévin 4c828bb399 BV SDIO: add SDIO mode 2019-02-20 18:30:23 +01:00
King Kévin f371217492 terminal: make prefix bold 2018-09-01 11:08:04 +02:00
King Kévin eff30a6431 BV I2C: add text styles 2018-09-01 01:05:56 +02:00
King Kévin 7f7994678f BV I2C: improve bus error detection code 2018-09-01 00:58:00 +02:00
King Kévin 956188fdee BV I2C (minor): use hex prefix 2018-09-01 00:36:07 +02:00
King Kévin 93d3d3048e BV I2C (minor): add space around operators 2018-09-01 00:34:47 +02:00
King Kévin 5faaeb02cc BV: add text styling methods 2018-09-01 00:30:32 +02:00
King Kévin fbb6fd18cc BV: display reset cause when debugging 2018-09-01 00:28:14 +02:00
King Kévin fe84d49ca4 BV: increase boot screen time 2018-09-01 00:26:33 +02:00
King Kévin 2c69034251 1-Wire: fix doc 2018-08-11 18:46:07 +02:00
King Kévin ee3d9c505a BV: set version in USB serial string 2018-08-11 18:44:05 +02:00
King Kévin c2a573ea65 fix library dependency 2018-08-11 18:43:23 +02:00
King Kévin 82c0b9cb31 BV 1-Wire: print parsed ROM ID 2018-08-11 18:42:55 +02:00
King Kévin 636cce8fdc 1-Wire: add family code device table 2018-08-11 18:42:10 +02:00
King Kévin a752d5a26b Rakefile (minor): make defu-util command more readable 2018-08-11 18:41:23 +02:00
King Kévin 1fe300335d BV RS485: add timer for baud rate detection 2018-07-13 18:32:15 +02:00
King Kévin 6b8255c5d9 BV RS232: add timer for baud rate detection 2018-07-13 18:31:59 +02:00
King Kévin 847e7d189c BV UART: add timer for baud rate detection 2018-07-13 18:31:39 +02:00
King Kévin ae3621faba UART: use pre/post rx in baud rate detection 2018-07-13 18:30:45 +02:00
King Kévin 1cb08356ec BV UART: add serial configuration auto-detection command 2018-07-11 08:21:41 +02:00
King Kévin 8dd5b89944 USART: put parity LUT in header so others can use it 2018-07-11 08:20:51 +02:00
King Kévin 62cc65d954 1-wire: add option to use interrupt redirection 2018-07-11 08:10:25 +02:00
King Kévin b8fcf17af9 interrupt: add library to redirect ISR at runtime 2018-07-11 08:09:04 +02:00
King Kévin 41db753338 BV: display version on screen when booting 2018-07-01 15:26:41 +02:00
King Kévin 7fc6551dfe BV OLED: add and use generic text drawing function 2018-07-01 15:26:11 +02:00
King Kévin 863af91eca font: update font and store in seperate library 2018-07-01 15:25:24 +02:00
King Kévin 097bba6398 global: disable debug 2018-07-01 15:24:33 +02:00
King Kévin 9a97f97218 BV RS-485: use generic UART library 2018-06-17 12:11:34 +02:00
King Kévin 753ae0992e BV RS-232: use generic UART library 2018-06-17 12:10:54 +02:00
King Kévin e9b88c49b3 BV UART: wait for transfer to complete before switching it off 2018-06-17 12:09:50 +02:00
King Kévin 0156f349bc BV UART: rename USART definition 2018-06-16 21:09:23 +02:00
King Kévin b213c1047b BV UART: fix doc 2018-06-16 21:08:39 +02:00
King Kévin b92273bc3e BV 1-wire: don't search when data line is not high 2018-06-16 11:06:24 +02:00
King Kévin 867aef09e3 BV UART: discard input used to interrupt a process 2018-06-16 11:05:48 +02:00
King Kévin 478e8dafb6 1-wire: stop search when not slave is detected, and mention that code 0 means the data line might not be pulled up 2018-06-16 11:05:12 +02:00
King Kévin cfd7c609b0 BV UART: mini fix to help preventing devel oversight 2018-06-15 10:20:55 +02:00
King Kévin 6fb3952997 BV UART: make UART mode use the generic methods 2018-06-15 09:48:41 +02:00
King Kévin 47a09a9e4a BV UART: add generic UART mode functions 2018-06-15 09:47:22 +02:00
King Kévin 054b2c252b BV UART: use enhanced USART to add additional data bits and parity support 2018-06-14 13:21:16 +02:00
King Kévin ea28f20464 USART enhanced: add additional data bits and parity support 2018-06-14 13:20:24 +02:00
King Kévin dc389ceaeb UART: fix transmission problem when buffer is full 2018-06-14 13:18:51 +02:00
King Kévin 772cbe70ea global: add macro for TIM_SR_CCOF and RST_USART 2018-06-14 13:17:01 +02:00
King Kévin beb4e061d8 Rakefile: use gcc as linker instead of ld to profit from library finding 2018-06-12 21:14:18 +02:00
King Kévin 5ad695c159 BV HiZ: fix function name for hardware v0 2018-05-09 21:37:19 +02:00
King Kévin 25a458c99d BV: add 1-Wire mode 2018-05-09 21:27:52 +02:00
King Kévin 97bdd20d18 BV 1-Wire: add 1-Wire mode 2018-05-09 21:27:44 +02:00
King Kévin f745c93b7f 1-Wire: remove misleading parasitic power function, add byte function 2018-05-09 21:27:00 +02:00
King Kévin a425e43590 BV: change LED handling. red LED is for power, blue LED is for activity 2018-05-03 12:56:09 +02:00
King Kévin 6e13f5eadd global: remove BV specific LEDs functions 2018-05-03 12:54:55 +02:00
King Kévin 750cfd3b4c BV: add RS-485/422 support 2018-05-01 13:45:09 +02:00
King Kévin 4d799ab4a3 BV RS485: add RS-485/422 support 2018-05-01 13:44:28 +02:00
King Kévin c55f663e56 BV RS232: fix typo 2018-05-01 13:43:56 +02:00
King Kévin 870284e581 USB: fix packet loss 2018-04-30 18:08:20 +02:00
King Kévin 8bb5c94285 HACKING: add BUSVOODOO_HARDWARE_VERSION note for verion 0 to 2018-04-30 18:08:03 +02:00
King Kévin 49344a7b15 BV: add BusVoodoo hardware version 0 support in main branch, using environment variable 2018-04-28 17:45:21 +02:00
King Kévin 5ea67d2250 BV: fix ADC blocking (caused by delays added by USB interrupts) 2018-04-28 13:56:03 +02:00
King Kévin c0c9b83543 USB: fix user buffer overwrite 2018-04-28 13:54:49 +02:00
King Kévin ae717d162e update code to libopencm3 API change 2018-04-28 12:22:19 +02:00
King Kévin fd393cb76d update code to libopencm3 API change 2018-04-28 12:21:32 +02:00
King Kévin a5b17e61bc updated libopencm3 submodule 2018-04-27 21:38:52 +02:00
King Kévin 1b1cba16cf README: put development information in separate file 2018-04-08 15:46:17 +02:00
King Kévin 5129277b6b USB: improve comments and a fix of code 2018-04-08 15:45:34 +02:00
King Kévin 2fc1a23676 Rakefile: remove reset functionnality 2018-04-08 15:45:07 +02:00
King Kévin 67b232f96e ld: fix SRAM size 2018-04-07 11:15:29 +02:00
King Kévin de6d3cb134 application: ony prevent clock halt when in debugging mode 2018-04-07 11:15:05 +02:00
King Kévin 46341317be USB: fix BV comment 2018-04-07 11:13:53 +02:00
King Kévin 1baf3bbea9 bootloader: fix SRAM comment 2018-04-07 11:13:08 +02:00
King Kévin cd9e9cccab flash_internal: fix page size detection 2018-04-07 11:12:17 +02:00
King Kévin 9b50d14c42 ld: improve flash size enforcing comment 2018-04-06 20:04:32 +02:00
King Kévin 0048f5ceb1 flash internal: check enforced flash size 2018-04-06 19:58:16 +02:00
King Kévin b2095171b4 BV RS-232: fix doc 2018-04-04 17:21:51 +02:00
King Kévin b2d4dd9acd USB: fix doc 2018-04-04 17:21:35 +02:00
King Kévin f6724f335e BV RS-232: add RS-232 support 2018-04-04 17:16:20 +02:00
King Kévin 8013408eed BV: support full only modes 2018-04-04 17:15:42 +02:00
King Kévin 5dc18f91a2 BV: support full only modes 2018-04-04 17:14:36 +02:00
King Kévin 9fe271f40a global: re-enable sleep in sleep_ms 2018-04-04 17:13:02 +02:00
King Kévin fabf59a220 take updated bootloader from master branch 2018-04-03 17:56:31 +02:00
King Kévin fed67eaa6a Rakefile: fix typo 2018-04-03 16:50:09 +02:00
King Kévin 583eb54b6f BV: improve help text 2018-04-03 15:42:19 +02:00
King Kévin e5b9d0fd85 BV I2C: add bus error checks 2018-04-03 15:41:54 +02:00
King Kévin ebcaf5723e I2C: add bus error checks 2018-04-03 15:41:31 +02:00
King Kévin 9ddb85bdcb USB: fix again too early data transfer 2018-04-03 14:01:20 +02:00
King Kévin 91e085d6a6 BV HiZ: improve tests 2018-04-02 21:10:54 +02:00
King Kévin ee184b0144 BV HiZ: broaden voltage range used during tests 2018-04-02 20:44:19 +02:00
King Kévin 72c3fc8677 OLED: better device presence check 2018-04-02 20:38:59 +02:00
King Kévin 5fa6a58e9b I2C: improve bus signal probing 2018-04-02 20:37:52 +02:00
King Kévin 1065a37cdb USB: reduce buffer size to save RAM 2018-03-23 14:24:34 +01:00
King Kévin 25b0466aee print: fix padding and fractional accumulation 2018-03-23 09:09:26 +01:00
King Kévin 17a2cc4465 BV HIZ: can now halt on error in tests 2018-03-23 08:49:39 +01:00
King Kévin 2d99d7f6f9 BV SPI: fix typo in comment 2018-03-22 16:05:26 +01:00
King Kévin aa11257c63 BV UART: add error command 2018-03-22 16:05:06 +01:00
King Kévin 760b8c2a46 BV UART: add action command 2018-03-22 15:57:49 +01:00
King Kévin 5d820ce6fa BV UART: add hex and bin display in receive command 2018-03-22 15:05:09 +01:00
King Kévin d8f04beb3f BV UART: add ability to exit in transceive command 2018-03-22 14:30:50 +01:00
King Kévin 2b67bd9608 BV UART: update code and add hardware flow control 2018-03-22 13:53:05 +01:00
King Kévin 93c8494b31 BV SPI: add LED activity indication 2018-03-22 12:09:56 +01:00
King Kévin ad4c9e06dd BV: use recommended pulse duration 2018-03-22 12:09:18 +01:00
King Kévin c36e786d93 BV global: rename led pulsing functions 2018-03-22 12:01:47 +01:00
King Kévin a5c9b3558d global: rename USART macros 2018-03-22 12:00:54 +01:00
King Kévin 5f889ba8b0 BV: fix doc 2018-03-21 23:20:39 +01:00
King Kévin 3bde5daecd fix doc 2018-03-21 23:20:05 +01:00
King Kévin ed8ce665fc Rakefile: add additional system library path 2018-03-21 22:58:47 +01:00
King Kévin 53dda1e50f BV I2C: add activity LED 2018-03-21 15:41:09 +01:00
King Kévin 87d68d5b48 BV I2C: add action command 2018-03-21 14:15:15 +01:00
King Kévin b8304d588f BV SPI: minor text fix 2018-03-21 14:14:46 +01:00
King Kévin 6a35bdc263 OLED: update to I2C API 2018-03-21 14:14:17 +01:00
King Kévin 2fec5cf247 I2C: add return codes 2018-03-21 14:13:55 +01:00
King Kévin 708e3d195b global: disable debug 2018-03-21 10:14:27 +01:00
King Kévin 422b76cd75 BV I2C: add 10-bit slave address support 2018-03-21 10:14:00 +01:00
King Kévin 0cfde88015 OLED: update to I2C API 2018-03-21 10:13:06 +01:00
King Kévin f6c50cb196 I2C: add 10 bits slave address support, improve reliability, and remove timer 2018-03-21 10:10:19 +01:00
King Kévin 6e160c31af I2C: add frequency support instead of just fast mode 2018-03-20 14:25:51 +01:00
King Kévin 944379fda9 BV: minor string fix 2018-03-20 10:46:40 +01:00
King Kévin 1ea54db293 BV: display pull-up information correctly 2018-03-20 10:42:59 +01:00
King Kévin 96507c584e BV HiZ: minor code improvement 2018-03-20 10:42:27 +01:00
King Kévin 05810060d7 BV: set power command to P and pinout to p 2018-03-20 10:41:30 +01:00
King Kévin 5ecea30801 BV: fix pinout 2018-03-20 10:15:36 +01:00
King Kévin fc8c73be49 global: remove unused I2C macros 2018-03-20 09:39:41 +01:00
King Kévin 78bbc8ae1e I2C: remove obsolete library 2018-03-20 09:39:14 +01:00
King Kévin 1be97ae21b BV I2C: update to new I2C library 2018-03-20 09:38:18 +01:00
King Kévin 82e33023de OLED: update to new I2C library 2018-03-20 09:38:06 +01:00
King Kévin 14cdeba690 I2C: allows multiple I2C peripherals to be used 2018-03-20 09:37:31 +01:00
King Kévin fed8637079 BV SPI: add action handler 2018-03-17 19:42:01 +01:00
King Kévin 2ec1d22a99 BV HiZ: improve doc 2018-03-17 19:41:20 +01:00
King Kévin cd7ca9a872 BV: add global action parser 2018-03-17 19:40:44 +01:00
King Kévin 70b166c1cc menu: pass remaning of line instead of word when argument is a string 2018-03-17 19:24:34 +01:00
King Kévin 8d0dfeef32 remove unused library 2018-03-17 13:35:12 +01:00
King Kévin af666455bd BV: move version and bootloader command to HiZ mode to reduce menu size in other modes 2018-03-15 19:20:27 +01:00
King Kévin 6391674bb7 application: add SPI mode 2018-03-15 19:00:04 +01:00
King Kévin efe89f61d4 BV SPI: add initial support 2018-03-15 18:59:44 +01:00
King Kévin bb014ce1e0 BV I2C: use shared string buffer and improve code 2018-03-15 18:55:52 +01:00
King Kévin 510d3c7193 BV I2C: use shared string buffer 2018-03-15 18:55:31 +01:00
King Kévin 56168c6c0c BV: add global shared string buffer to save RAM 2018-03-15 18:54:45 +01:00
King Kévin 06664a3916 I2C: ensure RCC_AFIO is on 2018-03-15 18:53:54 +01:00
King Kévin 5357985bad remove unused libraries 2018-03-11 23:40:43 +01:00
King Kévin 9ba771b92e application: add BV I2C 2018-03-11 17:52:20 +01:00
King Kévin 07b4cb10cc BV I2C: add initial I2C support 2018-03-11 17:51:53 +01:00
King Kévin 141fa4f2c9 BV HiZ: add RS/CAN pinout 2018-03-11 13:37:14 +01:00
King Kévin 911dc4c1a3 BV: fix RS/CAN pinout display 2018-03-11 13:36:50 +01:00
King Kévin ab3955b15b README: add link to manual 2018-03-11 13:19:24 +01:00
King Kévin 41976d0af8 USB: sleep_ms can't be used for DFU detach (in an interrupt) 2018-03-01 17:45:29 +01:00
King Kévin d8934dc4c5 global: minor code improvement 2018-03-01 17:44:18 +01:00
King Kévin 013092166e Rakefile: update USB ID for DFU 2018-03-01 17:43:09 +01:00
King Kévin db930f645c BV: unify ADC readout 2018-02-26 14:56:23 +01:00
King Kévin b04fcb7d3e USB: clean disconnect 2018-02-26 12:41:24 +01:00
King Kévin face9da9d0 Rakefile: check for changes in dependecies for source files 2018-02-26 12:14:52 +01:00
King Kévin edad01f1f7 application: display version 2018-02-26 12:14:11 +01:00
King Kévin 02be8b122e BV: rename revision to version 2018-02-26 12:13:45 +01:00
King Kévin 0f712e5c0a USB: improve transmission and wait until port is opened before starting transmission 2018-02-26 12:13:12 +01:00
King Kévin fdff675c67 BV: only read ADC measurement for channel selected 2018-02-23 16:03:55 +01:00
King Kévin 2327a3b5f2 BV: fix typo 2018-02-23 16:03:12 +01:00
King Kévin 12182e3667 application: remove unused button handling 2018-02-23 16:00:04 +01:00
King Kévin b3bfcf9e77 USB: provide connectivity flag 2018-02-23 15:59:28 +01:00
King Kévin 721e181f15 USB: increase transmit buffer and simplify locking mechanism 2018-02-23 12:38:59 +01:00
King Kévin 22932d0135 USB: set pid.codes BusVoodoo USB ID and improve description 2018-02-23 11:34:21 +01:00
King Kévin 074546f66e flash: get page size from device instead of hardcoded value 2018-02-18 14:16:16 +01:00
King Kévin f05ab20021 bootloader: add capability to override advertised flash size 2018-02-18 13:54:45 +01:00
King Kévin c0c6b8f0af BV HiZ: display pins on OLED for pins test 2018-02-16 13:13:11 +01:00
King Kévin 0e4628532d BV OLED: only test OLED screen in debug mode 2018-02-16 13:12:39 +01:00
King Kévin ba5dfece98 BV OLED: fix glyph 2018-02-16 12:31:35 +01:00
King Kévin e20d1fbf4d BV HiZ: add CAN pns test 2018-02-14 15:08:23 +01:00
King Kévin 5dda9a5fc8 BV HiZ: add CAN self-test 2018-02-14 14:27:23 +01:00
King Kévin ebd78bc898 BV: fix comment 2018-02-14 14:25:01 +01:00
King Kévin a06d8f1647 BV HiZ: improved pins test error messages 2018-02-14 14:06:06 +01:00
King Kévin 6babde53ee BV HiZ: add RS-485 pins test 2018-02-14 13:14:32 +01:00
King Kévin 6afccfdb82 BV HiZ: add RS-485 self-test 2018-02-14 12:35:23 +01:00
King Kévin 5bea250ba3 BV: fix RCC domains must be enabled individually 2018-02-13 20:35:48 +01:00
King Kévin fee77b8231 BV: fix going to safe state on full version, and RS485 pin info 2018-02-13 19:27:15 +01:00
King Kévin 8774be07cd BV HiZ: use red/blue LED to indicate user action is needed for test 2018-02-13 17:43:08 +01:00
King Kévin 6f8bbca2bf always enable debug (to need to save power) 2018-02-13 17:33:06 +01:00
King Kévin aa64816fc6 use red led function for BV 2018-02-13 17:32:20 +01:00
King Kévin 5dc9ad0286 BV: add specific function to switch blue and red LED on 2018-02-13 17:31:52 +01:00
King Kévin 216557b99e BV: change DFU pin to current revision 2018-02-13 16:54:51 +01:00
King Kévin 31e544c09f BV: update I/O pin names 2018-02-13 16:45:46 +01:00
King Kévin 2268315e84 application: show hardware revision 2018-02-13 16:20:17 +01:00
King Kévin d75b42377d BV: add hardware revision variable and identification 2018-02-13 16:19:45 +01:00
King Kévin 400df7c392 BV HiZ: fix self-test for unreadable ID CODE 2018-02-13 16:10:31 +01:00
King Kévin a0b5e2059f add GPLv3 license file 2018-02-13 15:14:55 +01:00
King Kévin d041eabf7b Rakefile: remove stripping since it does not decrease the size on binary output 2018-02-13 13:50:43 +01:00
King Kévin 59094a05d3 bootloader: fix linker script to indicate correct flash size for STM32F103xC 2018-02-13 13:47:03 +01:00
King Kévin afd0f5545d bootloader: show red LED on BV 2018-02-12 19:41:20 +01:00
King Kévin 993e0735c3 global: fix typo 2018-02-12 19:40:05 +01:00
King Kévin bf37193568 BV HiZ: make pin test faster an user interruptable 2018-02-12 17:13:22 +01:00
King Kévin ee5e5cf244 BV global: put RS-485 and CAN transceivers in safe mode 2018-02-12 14:08:53 +01:00
King Kévin 912509925e BV: fix typo 2018-02-12 13:30:21 +01:00
King Kévin 9d31e9b6a4 BV: split vreg_set to lv and hv 2018-02-06 21:34:29 +01:00
King Kévin 2df0fbf96f BV: rename xV to LV and 12V to HV 2018-02-06 21:17:37 +01:00
King Kévin b885553c6c application: display build date and device ID 2018-02-06 21:17:00 +01:00
King Kévin dc096e932b global: add macros to get built date 2018-02-06 21:16:25 +01:00
King Kévin 95c64eb081 BV UART: add pinout 2018-02-06 17:35:14 +01:00
King Kévin cd289dd537 BV HiZ: add pinout 2018-02-06 17:35:05 +01:00
King Kévin 36e78dbfb6 BV: clear pinout when switching mode 2018-02-06 17:28:03 +01:00
King Kévin 220b3b8880 BV OLED: use pin number ordering in pinout 2018-02-06 17:27:09 +01:00
King Kévin f840b5f075 BV: add pinout display functionnality 2018-02-06 17:26:35 +01:00
King Kévin 36e28c873f terminal: increase history 2018-02-06 17:25:53 +01:00
King Kévin 678d56aa68 menu: put tab when there is no option 2018-02-06 17:25:36 +01:00
King Kévin 86bd6d0978 BV UART: display mode and pinout on OLED display 2018-02-06 12:33:00 +01:00
King Kévin 434c664d5b BV HiZ: display mode and pinout on OLED display 2018-02-06 12:32:44 +01:00
King Kévin 980bc67419 BV: use OLED display 2018-02-06 12:31:46 +01:00
King Kévin 36569fd7ef OLED: switch I2C clock to fast mode 2018-02-06 12:31:30 +01:00
King Kévin 6111f30f4e BV OLED: fix drawing 2018-02-06 12:28:26 +01:00
King Kévin b1ce81eeda BV UART: fix escape count 2018-02-06 11:56:18 +01:00
King Kévin aa4548def5 BV: add functions to display text and pinout on OLED dispay 2018-02-06 11:55:43 +01:00
King Kévin 1b65542dda lib: add library to control SSD1306 I2C OLED displays 2018-02-06 11:54:57 +01:00
King Kévin 2522939c66 I2C: make API more generic 2018-02-06 11:53:50 +01:00
King Kévin 50bea30599 correct flash size to 256 kB of STM32F103xC 2018-02-06 11:52:23 +01:00
King Kévin af7d13dfef BV UART: add transceive command 2018-01-25 11:31:27 +01:00
King Kévin de4218147e BV HiZ: replace wait_space with user_input_get 2018-01-25 10:41:43 +01:00
King Kévin 37b02552fd global: remove wait_space since it can be done by user_input_get 2018-01-25 10:41:02 +01:00
King Kévin 5f10bc3424 global: make user_input_get blocking 2018-01-24 22:25:12 +01:00
King Kévin a9b0ad9f62 application: use central user input storage 2018-01-24 22:19:11 +01:00
King Kévin 9b025c743e USB: use central user input storage 2018-01-24 22:18:58 +01:00
King Kévin 7657812ead uart: user central user input storage 2018-01-24 22:18:37 +01:00
King Kévin ae3ac4e2ed global: add central user input storage 2018-01-24 22:18:11 +01:00
King Kévin 77263ecaa2 busvoodoo: improve instructions 2018-01-24 22:17:32 +01:00
King Kévin 33b5b0352b application: switch LED off after exiting mode 2018-01-24 21:30:38 +01:00
King Kévin 1633972d8d busvoodoo: set LED when HiZ is started 2018-01-24 21:30:03 +01:00
King Kévin b875d88bd5 busvoodoo: use LED for UART activity 2018-01-24 21:29:22 +01:00
King Kévin a91161981c busvoodoo: add led blinking with timeout 2018-01-24 21:28:45 +01:00
King Kévin 513bee9298 busvoodoo: add UART mode to list of supported modes 2018-01-24 16:37:00 +01:00
King Kévin da1786228a busvoodoo: add UART mode (incomplete) 2018-01-24 16:36:19 +01:00
King Kévin b6419954f7 prinf: fix printing 1.0 2018-01-24 16:34:24 +01:00
King Kévin 5d472aacbe busvoodoo: enable clock for alternative domains 2018-01-24 15:58:00 +01:00
King Kévin 5f681b9c0e busvoodoo: fux typo 2018-01-24 15:57:34 +01:00
King Kévin 657df679a3 busvoodoo: add name and description to mode interface 2018-01-23 23:41:41 +01:00
King Kévin 6b300b5ed9 terminal: add ': ' to prompt prefix 2018-01-23 23:40:59 +01:00
King Kévin e1259c6cdc busvoodoo: add quit mode command 2018-01-23 15:36:05 +01:00
King Kévin 8b7b262065 busvoodoo: add HiZ mode interface 2018-01-23 15:18:41 +01:00
King Kévin d2734a6fd7 busvoodoo: add mode interface definition 2018-01-23 15:17:43 +01:00
King Kévin 33a847b8e7 busvoodoo: adjust voltage control 2018-01-23 11:28:38 +01:00
King Kévin edf1a9e59c application: offer global busvoodoo commands 2018-01-22 21:43:09 +01:00
King Kévin 5b57060802 busvoodoo: add global commands to control power rails 2018-01-22 21:42:40 +01:00
King Kévin 8c983712b0 menu: make copy of line to process since strtok can modify original string 2018-01-22 21:41:52 +01:00
King Kévin ddbd821243 busvoodoo: set pin test shortcut to t and fix typo 2018-01-22 21:40:53 +01:00
King Kévin 3e210ae720 busvoodoo: add HiZ commands 2018-01-21 23:43:37 +01:00
King Kévin c9c017ac29 application: move wait_space to global 2018-01-21 23:36:11 +01:00
King Kévin a822c9b131 application: use menu library 2018-01-21 23:35:42 +01:00
King Kévin afb39f2dd0 menu: add library to handle commands 2018-01-21 23:35:22 +01:00
King Kévin 25c44e9568 bootloader: fix comment 2018-01-21 18:39:10 +01:00
King Kévin b2c823f858 application: add reset action 2018-01-17 18:30:08 +01:00
King Kévin 4a8bf5d2a1 busvoodoo: add method to control embedded pull-up resistors 2018-01-17 18:25:59 +01:00
King Kévin f834f3bd63 busvoodoo: add method to control power output 2018-01-17 13:17:08 +01:00
King Kévin 4f0a09f717 busvoodoo: add method to set voltage 2018-01-17 12:28:15 +01:00
King Kévin e064cce4f0 application: remove watchdog because menues can block 2018-01-17 12:27:32 +01:00
King Kévin bffb766368 Rakefile: add compile target 2018-01-17 12:26:32 +01:00
King Kévin ea4a0c518f application: move BusVoodoo specific parts to separate library 2018-01-14 22:15:00 +01:00
King Kévin c3a5aa6540 application: use terminal prompt 2018-01-14 13:49:16 +01:00
King Kévin f759017192 terminal: add terminal prompt library 2018-01-14 13:46:51 +01:00
King Kévin af791d12d4 ignore vim and gdb files 2018-01-14 13:35:28 +01:00
King Kévin bf896b920a uart: fix typo 2018-01-12 11:32:09 +01:00
King Kévin 7d78986f13 uart: make receiving bytes more reliable 2018-01-12 11:31:58 +01:00
King Kévin 5f5f7c9558 application: display mockup pinout on OLED screen 2018-01-04 14:33:35 +01:00
King Kévin b42d693bd0 README: fix typo 2017-12-23 15:13:35 +01:00
King Kévin fb1170a258 README: fix typo 2017-12-23 15:11:38 +01:00
King Kévin 606b320a15 README: describe BusVoodoo 2017-12-23 15:10:30 +01:00
King Kévin 6c554a9ffd application: improve self-test and add pin test 2017-12-22 17:25:05 +01:00
King Kévin bebb9f37ac global: fix typo 2017-12-22 17:20:56 +01:00
King Kévin e8d20146a2 uart: remove legact usart replaced by uart 2017-12-17 03:54:12 +01:00
King Kévin 238acd29c3 usart: update date 2017-12-16 13:41:03 +01:00
King Kévin a695fd595e uart: fix typo 2017-12-16 13:40:30 +01:00
King Kévin 1b24f5e05c application: update usart to uart 2017-12-16 13:37:35 +01:00
King Kévin 5f19504c6b usart: renamed to uart because not synchroneous 2017-12-16 13:36:51 +01:00
King Kévin 6302c1af74 usart: lower baudrate to 921600 to not drop incoming traffic 2017-12-16 13:25:30 +01:00
King Kévin 0cfbb1b4d8 usart: higher incoming traffic capabilities 2017-12-16 13:24:31 +01:00
King Kévin 5773f62be2 application: add voltages check to self-tests 2017-12-15 19:10:56 +01:00
King Kévin 2ede3ef1b2 print: add floating point numbers support 2017-12-14 10:23:31 +01:00
King Kévin f5355fe75a print: add support for uint64 bits 2017-12-13 14:16:28 +01:00
King Kévin 8542914426 print: fix doc 2017-12-13 14:11:34 +01:00
King Kévin ed0245ae54 print: add support for uint64_t hexadecimal 2017-12-13 14:07:18 +01:00
King Kévin dba76454af print: add error handling with user output 2017-12-13 13:48:29 +01:00
King Kévin d001ed14e6 print: allow padding size > 9 2017-12-13 12:30:16 +01:00
King Kévin 11924349db global: correct DFU pin for BusVoodoo v0.018 2017-12-12 13:57:30 +01:00
King Kévin 89b79db511 application: add BusVoodoo boards tests 2017-12-12 13:56:28 +01:00
King Kévin 57556ba19c global: add function to control LED blinking using PWM 2017-12-12 13:55:38 +01:00
King Kévin f34a8e9244 Rakefile: set BusVoodoo as default board 2017-12-12 13:54:15 +01:00
King Kévin c00e8d29f9 global: add BusVoodoo board support 2017-11-24 11:29:53 +01:00
King Kévin c611911637 global: simplify board support 2017-11-24 11:29:10 +01:00
79 changed files with 11647 additions and 5129 deletions

2
.gitignore vendored
View File

@ -7,4 +7,6 @@
*.elf
*.bin
*.swp
*.swo
.gdb_history
doc/

74
HACKING.md Normal file
View File

@ -0,0 +1,74 @@
The following information will focus on the software development.
board
=====
The BusVoodoo uses a [custom board](https://bus.cuvoodoo.info/manual/index.html#_hardware_development) based on a [STM32F103RC](http://www.st.com/en/microcontrollers/stm32f103rc.html) micro-controller.
code
====
dependencies
------------
To develop the firmware, following Linux packages are required:
- _arm-none-eabi-gcc_ to compile the source code
- _arm-none-eabi-binutils_ to create the firmware binaries
- _arm-none-eabi-gdb_ to debug the firmware
- _rake_ automate development steps
- _openocd_ to flash and debug over SWD (when using an ST-Link V2 adapter)
- _doxygen_ to compile the documentation
The source code uses the [libopencm3](http://libopencm3.org/) library.
The projects is already a git submodules.
It will be initialized when compiling the firmware.
Alternatively you can run once: `git submodule init` and `git submodule update`.
firmware
--------
To compile the firmware files run `rake`.
This will generate two firmware:
- _bootloader_: a USB DFU bootloader
- _application_: the main application
*IMPORTANT*: to build the firmware for BusVoodoo hardware version 0, prepend `BUSVOODOO_HARDWARE_VERSION=0` before every `rake` command. This will make sure the few pin assignment differences are taken into account in the firmware.
documentation
-------------
To generate doxygen documentation run `rake doc`.
The documentation describing all files, functions, and variables will be available in the _doc_ folder.
Further comments are in the source code.
flash
-----
There are two firmware images: `bootloader` and `application`.
The `bootloader` image allows to flash the `application` over USB using the DFU protocol.
The `bootloader` is started first and immediately jumps to the `application` if it is valid and the DFU mode is not forced.
The `application` image is the main application and is implemented in `application.c`.
The `bootloader` image will be flashed using SWD (Serial Wire Debug).
For that you need an SWD adapter.
The `Makefile` uses a Black Magic Probe (per default), or a ST-Link V2 along OpenOCD software.
To flash the `booltoader` using SWD run `rake flash_booloader`.
Once the `bootloader` is flashed it is possible to flash the `application` over USB using the DFU protocol by running `rake flash`.
The `application` advertises USB DFU support (along with the USB CDC ACM class).
If the application is broken, force the bootloader to start the DFU mode by shorting the contacts marked as DFU on the board while powering up.
It is also possible to flash the `application` image using SWD by running `rake flash_application`.
debug
-----
SWD also allows to debug the code running on the micro-controller using GDB.
To start the debugging session run `rake debug`.
USB
---
The firmware offers serial communication over USART 1 and USB (using the CDC ACM device class).

674
LICENSE.txt Normal file
View File

@ -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>.

116
README.md
View File

@ -1,4 +1,4 @@
This firmware template is designed for development boards based around [STM32 F1 series micro-controller](http://www.st.com/web/en/catalog/mmc/FM141/SC1169/SS1031).
This is the firmware for the [BusVoodoo](https://bus.cuvoodoo.info/).
project
=======
@ -6,87 +6,45 @@ project
summary
-------
*describe project purpose*
The BusVoodoo is a multi-protocol debugging adapter.
This tool allows to quickly communicate with various other electronic devices.
technology
----------
*described electronic details*
board
=====
The current implementation uses a [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board).
The underlying template also supports following board:
- [Maple Mini](http://leaflabs.com/docs/hardware/maple-mini.html), based on a STM32F103CBT6
- [System Board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#system_board), based on a STM32F103C8T6
- [blue pill](ihttps://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#blue_pill), based on a STM32F103C8T6
- [core board](https://wiki.cuvoodoo.info/doku.php?id=stm32f1xx#core_board), based on a STM32F103C8T6
**Which board is used is defined in the Makefile**.
This is required to map the user LED and button provided on the board
connections
===========
Connect the peripherals the following way (STM32F10X signal; STM32F10X pin; peripheral pin; peripheral signal; comment):
- *list board to preipheral pin connections*
All pins are configured using `define`s in the corresponding source code.
code
====
dependencies
------------
The source code uses the [libopencm3](http://libopencm3.org/) library.
The projects is already a git submodules.
It will be initialized when compiling the firmware.
Alternatively you can run once: `git submodule init` and `git submodule update`.
firmware
--------
To compile the firmware run `rake`.
documentation
-------------
To generate doxygen documentation run `rake doc`.
flash
-----
There are two firmware images: `bootloader` and `application`.
The `bootloader` image allows to flash the `application` over USB using the DFU protocol.
The `bootloader` is started first and immediately jumps to the `application` if it is valid and the DFU mode is not forced (i.e. by pressing the user button on the board or requesting a DFU detach in the `application`).
The `application` image is the main application and is implemented in `application.c`.
It is up to the application to advertise USB DFU support (i.e. as does the provided USB CDC ACM example).
The `bootlaoder` image will be flashed using SWD (Serial Wire Debug).
For that you need an SWD adapter.
The `Makefile` uses a Black Magic Probe (per default), or a ST-Link V2 along OpenOCD software.
To flash the `booltoader` using SWD run `rake flash_booloader`.
Once the `bootloader` is flashed it is possible to flash the `application` over USB using the DFU protocol by running `rake flash`.
To force the bootloader to start the DFU mode press the user button or short a pin, depending on the board.
It is also possible to flash the `application` image using SWD by running `rake flash_application`.
debug
-----
SWD also allows to debug the code running on the micro-controller using GDB.
To start the debugging session run `rake debug`.