├── mk ├── black_magic_probe_debug.scr ├── black_magic_probe_flash.scr ├── librfn.rules.mk ├── vccgnd_stm32f103.cfg ├── lctech_stm32f103.cfg ├── libopencm3.stm32f0xx.mk ├── libopencm3.stm32f1xx.mk ├── libopencm3.stm32f4xx.mk └── libopencm3.rules.mk ├── .gitignore ├── images ├── relay_board.jpg ├── combined_boards.jpg └── stm32f103c8t6_dev_board.jpg ├── .gitmodules ├── src ├── bootloader │ ├── README │ ├── Makefile │ ├── lctech-f103.ld │ └── usbdfu.c ├── stm32f4-relay │ ├── Makefile │ └── relay.c ├── stm32f0-relay │ ├── Makefile │ └── relay.c ├── stm32f4-relay-96bcarbon │ ├── Makefile │ ├── README.md │ └── relay.c ├── stm32f1-relay │ ├── Makefile │ └── relay.c ├── stm32f4-96bcarbon.ld ├── stm32f4-discovery.ld └── lctech-f103.ld ├── .clang-format ├── bin └── targetctl ├── README.md ├── Makefile └── COPYING /mk/black_magic_probe_debug.scr: -------------------------------------------------------------------------------- 1 | monitor version 2 | monitor swdp_scan 3 | attach 1 4 | run 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.bin 2 | *.d 3 | *.elf 4 | *.map 5 | *.o 6 | .*.swp 7 | README.html 8 | cscope.out 9 | -------------------------------------------------------------------------------- /mk/black_magic_probe_flash.scr: -------------------------------------------------------------------------------- 1 | monitor version 2 | monitor swdp_scan 3 | attach 1 4 | load 5 | -------------------------------------------------------------------------------- /images/relay_board.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daniel-thompson/tiny-manager/HEAD/images/relay_board.jpg -------------------------------------------------------------------------------- /images/combined_boards.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daniel-thompson/tiny-manager/HEAD/images/combined_boards.jpg -------------------------------------------------------------------------------- /images/stm32f103c8t6_dev_board.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/daniel-thompson/tiny-manager/HEAD/images/stm32f103c8t6_dev_board.jpg -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "librfn"] 2 | path = librfn 3 | url = https://github.com/daniel-thompson/librfn.git 4 | [submodule "libopencm3"] 5 | path = libopencm3 6 | url = https://github.com/libopencm3/libopencm3.git 7 | -------------------------------------------------------------------------------- /src/bootloader/README: -------------------------------------------------------------------------------- 1 | ------------------------------------------------------------------------------ 2 | README 3 | ------------------------------------------------------------------------------ 4 | 5 | This bootloader implements a USB Device Firmware Upgrade (DFU) bootloader. 6 | 7 | Board connections: 8 | ------------------ 9 | 10 | PA4 (optional LED) LED connected via a current limiting resistor to GND 11 | PA0 (button) Switch, connected to GND, to enable loader 12 | PB8 (hotplug) 1.5k resister connected to P2 pin 1 (next to push 13 | switch). This connection is optional but avoids the 14 | need to continually plug/unplug the board before and 15 | after programming. 16 | USB (mini USB) USB acting as device, connect to computer 17 | -------------------------------------------------------------------------------- /src/stm32f4-relay/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## 6 | ## This library is free software: you can redistribute it and/or modify 7 | ## it under the terms of the GNU Lesser General Public License as published by 8 | ## the Free Software Foundation, either version 3 of the License, or 9 | ## (at your option) any later version. 10 | ## 11 | ## This library is distributed in the hope that it will be useful, 12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ## GNU Lesser General Public License for more details. 15 | ## 16 | ## You should have received a copy of the GNU Lesser General Public License 17 | ## along with this library. If not, see . 18 | ## 19 | 20 | BINARY = relay 21 | 22 | DEFS += -DF_CPU=120000000 -DCONFIG_USB_MAX_POWER=500 23 | OBJS += console.o console_cdcacm.o console_cmd_gpio.o 24 | 25 | LDSCRIPT = ../stm32f4-discovery.ld 26 | include ../../mk/libopencm3.stm32f4xx.mk 27 | -------------------------------------------------------------------------------- /src/bootloader/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project. 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## 6 | ## This library is free software: you can redistribute it and/or modify 7 | ## it under the terms of the GNU Lesser General Public License as published by 8 | ## the Free Software Foundation, either version 3 of the License, or 9 | ## (at your option) any later version. 10 | ## 11 | ## This library is distributed in the hope that it will be useful, 12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ## GNU Lesser General Public License for more details. 15 | ## 16 | ## You should have received a copy of the GNU Lesser General Public License 17 | ## along with this library. If not, see . 18 | ## 19 | 20 | BINARY = usbdfu 21 | 22 | DEFS += -DF_CPU=48000000 23 | 24 | ifdef CONFIG_PLATFORM_MINI_STLINK 25 | DEFS += -DCONFIG_PLATFORM_MINI_STLINK=1 26 | endif 27 | 28 | LDSCRIPT = lctech-f103.ld 29 | 30 | include ../../mk/libopencm3.stm32f1xx.mk 31 | 32 | -------------------------------------------------------------------------------- /src/stm32f0-relay/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## 6 | ## This library is free software: you can redistribute it and/or modify 7 | ## it under the terms of the GNU Lesser General Public License as published by 8 | ## the Free Software Foundation, either version 3 of the License, or 9 | ## (at your option) any later version. 10 | ## 11 | ## This library is distributed in the hope that it will be useful, 12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ## GNU Lesser General Public License for more details. 15 | ## 16 | ## You should have received a copy of the GNU Lesser General Public License 17 | ## along with this library. If not, see . 18 | ## 19 | 20 | BINARY = relay 21 | 22 | DEFS += -DF_CPU=48000000 -DCONFIG_USB_MAX_POWER=500 23 | OBJS += console.o console_cdcacm.o console_cmd_gpio.o 24 | 25 | DFU_ADDRESS = 0x08000000 26 | LDSCRIPT = ../../libopencm3/lib/stm32/f0/stm32f04xz6.ld 27 | include ../../mk/libopencm3.stm32f0xx.mk 28 | -------------------------------------------------------------------------------- /src/stm32f4-relay-96bcarbon/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## 6 | ## This library is free software: you can redistribute it and/or modify 7 | ## it under the terms of the GNU Lesser General Public License as published by 8 | ## the Free Software Foundation, either version 3 of the License, or 9 | ## (at your option) any later version. 10 | ## 11 | ## This library is distributed in the hope that it will be useful, 12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ## GNU Lesser General Public License for more details. 15 | ## 16 | ## You should have received a copy of the GNU Lesser General Public License 17 | ## along with this library. If not, see . 18 | ## 19 | 20 | BINARY = relay 21 | 22 | DEFS += -DF_CPU=84000000 -DCONFIG_USB_MAX_POWER=500 23 | 24 | OBJS += console.o console_stm32.o console_cmd_gpio.o 25 | 26 | OOCD_BOARD = board/stm32f496bcarbon 27 | DFU_ADDRESS = 0x08000000 28 | 29 | LDSCRIPT = ../stm32f4-96bcarbon.ld 30 | include ../../mk/libopencm3.stm32f4xx.mk 31 | -------------------------------------------------------------------------------- /src/stm32f1-relay/Makefile: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project. 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## 6 | ## This library is free software: you can redistribute it and/or modify 7 | ## it under the terms of the GNU Lesser General Public License as published by 8 | ## the Free Software Foundation, either version 3 of the License, or 9 | ## (at your option) any later version. 10 | ## 11 | ## This library is distributed in the hope that it will be useful, 12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ## GNU Lesser General Public License for more details. 15 | ## 16 | ## You should have received a copy of the GNU Lesser General Public License 17 | ## along with this library. If not, see . 18 | ## 19 | 20 | BINARY = relay 21 | 22 | DEFS += -DF_CPU=72000000 -DCONFIG_USB_MAX_POWER=500 23 | OBJS += console.o console_cdcacm.o console_cmd_gpio.o 24 | 25 | ifdef CONFIG_PLATFORM_MINI_STLINK 26 | DEFS += -DCONFIG_PLATFORM_MINI_STLINK=1 27 | endif 28 | 29 | DFU_ADDRESS = 0x08002000 30 | LDSCRIPT = ../lctech-f103.ld 31 | 32 | include ../../mk/libopencm3.stm32f1xx.mk 33 | -------------------------------------------------------------------------------- /src/bootloader/lctech-f103.ld: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the libopencm3 project. 3 | * 4 | * Copyright (C) 2009 Uwe Hermann 5 | * 6 | * This library is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU Lesser General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General Public License 17 | * along with this library. If not, see . 18 | */ 19 | 20 | /* Linker script for LCTech STM32F103C8T6 development board. 48 pin package, 21 | * 128K flash (8K taken for DFU bootloader), 20K RAM. */ 22 | 23 | /* Define memory regions. */ 24 | MEMORY 25 | { 26 | rom (rx) : ORIGIN = 0x08000000, LENGTH = 8K 27 | ram (rwx) : ORIGIN = 0x20000000, LENGTH = 20K 28 | } 29 | 30 | /* Include the common ld script. */ 31 | INCLUDE cortex-m-generic.ld 32 | -------------------------------------------------------------------------------- /src/stm32f4-96bcarbon.ld: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the usb-relay project. 3 | * 4 | * Copyright (C) 2009 Uwe Hermann 5 | * Copyright (C) 2011 Stephen Caudle 6 | * 7 | * This library is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Lesser General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This library is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU Lesser General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Lesser General Public License 18 | * along with this library. If not, see . 19 | */ 20 | 21 | /* Linker script for ST STM32F496BCARBON (STM32F401RET, 512K flash, 96K RAM). */ 22 | 23 | /* Define memory regions. */ 24 | MEMORY 25 | { 26 | rom (rx) : ORIGIN = 0x08000000, LENGTH = 512K 27 | ram (rwx) : ORIGIN = 0x20000000, LENGTH = 96K 28 | } 29 | 30 | /* Include the common ld script. */ 31 | INCLUDE cortex-m-generic.ld 32 | -------------------------------------------------------------------------------- /src/stm32f4-discovery.ld: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the usb-relay project. 3 | * 4 | * Copyright (C) 2009 Uwe Hermann 5 | * Copyright (C) 2011 Stephen Caudle 6 | * 7 | * This library is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Lesser General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This library is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU Lesser General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Lesser General Public License 18 | * along with this library. If not, see . 19 | */ 20 | 21 | /* Linker script for ST STM32F4DISCOVERY (STM32F407VG, 1024K flash, 128K RAM). */ 22 | 23 | /* Define memory regions. */ 24 | MEMORY 25 | { 26 | rom (rx) : ORIGIN = 0x08000000, LENGTH = 1024K 27 | ram (rwx) : ORIGIN = 0x20000000, LENGTH = 128K 28 | } 29 | 30 | /* Include the common ld script. */ 31 | INCLUDE cortex-m-generic.ld 32 | -------------------------------------------------------------------------------- /src/lctech-f103.ld: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the usb-relay project. 3 | * 4 | * Copyright (C) 2014 Daniel Thompson 5 | * 6 | * This library is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU Lesser General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General Public License 17 | * along with this library. If not, see . 18 | */ 19 | 20 | /* Linker script for LCTech STM32F103C8T6 development board. 48 pin package, 21 | * 128K flash (8K taken for DFU bootloader), 20K RAM. */ 22 | 23 | /* Define memory regions. */ 24 | MEMORY 25 | { 26 | rom (rx) : ORIGIN = 0x08002000, LENGTH = 120K 27 | ram (rwx) : ORIGIN = 0x20000000, LENGTH = 20K 28 | } 29 | 30 | /* Include the common ld script. */ 31 | INCLUDE cortex-m-generic.ld 32 | 33 | -------------------------------------------------------------------------------- /mk/librfn.rules.mk: -------------------------------------------------------------------------------- 1 | # 2 | # This file of the part of the usb-relay project. 3 | # 4 | # Copyright (C) 2014 Dainiel Thompson 5 | # 6 | # This library is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU Lesser General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This library is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU Lesser General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU Lesser General Public License 17 | # along with this library. If not, see . 18 | # 19 | 20 | -include $(OBJS:.o=.d) 21 | 22 | LIBRFN_DIR = ../../librfn 23 | 24 | OBJS += \ 25 | fibre.o \ 26 | fibre_default.o \ 27 | list.o \ 28 | messageq.o \ 29 | ringbuf.o \ 30 | time_libopencm3.o \ 31 | util.o 32 | 33 | vpath %.c $(LIBRFN_DIR)/librfn 34 | vpath %.c $(LIBRFN_DIR)/librfn/libopencm3 35 | 36 | CPPFLAGS += -DNDEBUG 37 | CPPFLAGS += -DCONFIG_CONSOLE_FROM_ISR=1 38 | CPPFLAGS += -I$(LIBRFN_DIR)/include 39 | -------------------------------------------------------------------------------- /mk/vccgnd_stm32f103.cfg: -------------------------------------------------------------------------------- 1 | # 2 | # This file is part of the usb-relay project. 3 | # 4 | # Copyright (C) 2014 Daniel Thompson 5 | # 6 | # This library is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU Lesser General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This library is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU Lesser General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU Lesser General Public License 17 | # along with this library. If not, see . 18 | # 19 | 20 | # LCTech ARM Cortex-M3 STM32F103C8T6 STM32 core board development board 21 | # http://www.lctech-inc.com/Hardware/Detail.aspx?id=0172e854-77b0-43d5-b300-68e570c914fd 22 | 23 | source [find interface/stlink-v2.cfg] 24 | 25 | # Work-area size (RAM size) = 20kB for STM32F103C8T6 device 26 | set WORKAREASIZE 0x5000 27 | 28 | source [find target/stm32f1x_stlink.cfg] 29 | 30 | # use hardware reset, connect under reset 31 | reset_config none 32 | -------------------------------------------------------------------------------- /mk/lctech_stm32f103.cfg: -------------------------------------------------------------------------------- 1 | # 2 | # This file is part of the usb-relay project. 3 | # 4 | # Copyright (C) 2014 Daniel Thompson 5 | # 6 | # This library is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU Lesser General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This library is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU Lesser General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU Lesser General Public License 17 | # along with this library. If not, see . 18 | # 19 | 20 | # LCTech ARM Cortex-M3 STM32F103C8T6 STM32 core board development board 21 | # http://www.lctech-inc.com/Hardware/Detail.aspx?id=0172e854-77b0-43d5-b300-68e570c914fd 22 | 23 | source [find interface/stlink-v2.cfg] 24 | 25 | # Work-area size (RAM size) = 20kB for STM32F103C8T6 device 26 | set WORKAREASIZE 0x5000 27 | 28 | source [find target/stm32f1x_stlink.cfg] 29 | 30 | # use hardware reset, connect under reset 31 | reset_config srst_only srst_nogate 32 | -------------------------------------------------------------------------------- /mk/libopencm3.stm32f0xx.mk: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project. 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## Copyright (C) 2010 Piotr Esden-Tempski 6 | ## 7 | ## This library is free software: you can redistribute it and/or modify 8 | ## it under the terms of the GNU Lesser General Public License as published by 9 | ## the Free Software Foundation, either version 3 of the License, or 10 | ## (at your option) any later version. 11 | ## 12 | ## This library is distributed in the hope that it will be useful, 13 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ## GNU Lesser General Public License for more details. 16 | ## 17 | ## You should have received a copy of the GNU Lesser General Public License 18 | ## along with this library. If not, see . 19 | ## 20 | 21 | LIBNAME = opencm3_stm32f0 22 | DEFS += -DSTM32F0 23 | 24 | FP_FLAGS ?= -msoft-float 25 | ARCH_FLAGS = -mthumb -mcpu=cortex-m0 $(FP_FLAGS) 26 | 27 | ################################################################################ 28 | # OpenOCD specific variables 29 | 30 | OOCD ?= openocd 31 | OOCD_INTERFACE ?= stlink-v2 32 | OOCD_BOARD ?= stm32f0x 33 | 34 | ################################################################################ 35 | # Black Magic Probe specific variables 36 | # Set the BMP_PORT to a serial port and then BMP is used for flashing 37 | BMP_PORT ?= 38 | 39 | ################################################################################ 40 | # texane/stlink specific variables 41 | #STLINK_PORT ?= :4242 42 | 43 | 44 | include ../../mk/librfn.rules.mk 45 | include ../../mk/libopencm3.rules.mk 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /mk/libopencm3.stm32f1xx.mk: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project. 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## Copyright (C) 2010 Piotr Esden-Tempski 6 | ## 7 | ## This library is free software: you can redistribute it and/or modify 8 | ## it under the terms of the GNU Lesser General Public License as published by 9 | ## the Free Software Foundation, either version 3 of the License, or 10 | ## (at your option) any later version. 11 | ## 12 | ## This library is distributed in the hope that it will be useful, 13 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | ## GNU Lesser General Public License for more details. 16 | ## 17 | ## You should have received a copy of the GNU Lesser General Public License 18 | ## along with this library. If not, see . 19 | ## 20 | 21 | LIBNAME = opencm3_stm32f1 22 | DEFS += -DSTM32F1 23 | 24 | FP_FLAGS ?= -msoft-float 25 | ARCH_FLAGS = -mthumb -mcpu=cortex-m3 $(FP_FLAGS) -mfix-cortex-m3-ldrd 26 | 27 | ################################################################################ 28 | # OpenOCD specific variables 29 | 30 | OOCD ?= openocd 31 | OOCD_INTERFACE ?= stlink-v2 32 | OOCD_BOARD ?= ../../mk/vccgnd_stm32f103 33 | 34 | ################################################################################ 35 | # Black Magic Probe specific variables 36 | # Set the BMP_PORT to a serial port and then BMP is used for flashing 37 | BMP_PORT ?= 38 | 39 | ################################################################################ 40 | # texane/stlink specific variables 41 | #STLINK_PORT ?= :4242 42 | 43 | 44 | include ../../mk/librfn.rules.mk 45 | include ../../mk/libopencm3.rules.mk 46 | 47 | 48 | 49 | -------------------------------------------------------------------------------- /mk/libopencm3.stm32f4xx.mk: -------------------------------------------------------------------------------- 1 | ## 2 | ## This file is part of the usb-relay project. 3 | ## 4 | ## Copyright (C) 2009 Uwe Hermann 5 | ## Copyright (C) 2010 Piotr Esden-Tempski 6 | ## Copyright (C) 2011 Fergus Noble 7 | ## 8 | ## This library is free software: you can redistribute it and/or modify 9 | ## it under the terms of the GNU Lesser General Public License as published by 10 | ## the Free Software Foundation, either version 3 of the License, or 11 | ## (at your option) any later version. 12 | ## 13 | ## This library is distributed in the hope that it will be useful, 14 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ## GNU Lesser General Public License for more details. 17 | ## 18 | ## You should have received a copy of the GNU Lesser General Public License 19 | ## along with this library. If not, see . 20 | ## 21 | 22 | LIBNAME = opencm3_stm32f4 23 | DEFS += -DSTM32F4 24 | 25 | FP_FLAGS ?= -mfloat-abi=hard -mfpu=fpv4-sp-d16 26 | ARCH_FLAGS = -mthumb -mcpu=cortex-m4 $(FP_FLAGS) 27 | 28 | ################################################################################ 29 | # OpenOCD specific variables 30 | 31 | OOCD ?= openocd 32 | OOCD_INTERFACE ?= stlink-v2 33 | OOCD_BOARD ?= board/stm32f4discovery 34 | 35 | ################################################################################ 36 | # Black Magic Probe specific variables 37 | # Set the BMP_PORT to a serial port and then BMP is used for flashing 38 | BMP_PORT ?= 39 | 40 | ################################################################################ 41 | # texane/stlink specific variables 42 | #STLINK_PORT ?= :4242 43 | 44 | 45 | include ../../mk/librfn.rules.mk 46 | include ../../mk/libopencm3.rules.mk 47 | 48 | 49 | 50 | -------------------------------------------------------------------------------- /src/stm32f4-relay-96bcarbon/README.md: -------------------------------------------------------------------------------- 1 | usb-relay for Carbon 2 | ==================== 3 | 4 | [Carbon by Seeed and 96Boards](https://www.96boards.org/product/carbon/) 5 | is an STM32F401 based BLE development board. It's perhaps a little 6 | over-specified to use just to control relays, but if you have an unused 7 | one lying around its a great alternative to STM32F103 boards. 8 | 9 | Quickstart 10 | ---------- 11 | 12 | - Install the [Arm Embedded 13 | Toolchain](https://developer.arm.com/open-source/gnu-toolchain/gnu-rm) 14 | (or similar arm-none-eabi- compiler), openocd and dfu-util. 15 | - Clone this repo: 16 | `git clone https://github.com/daniel-thompson/usb-relay.git` 17 | - Fetch the libraries: 18 | `cd usb-relay; git submodule update --init --recursive` 19 | - Build the firmware: 20 | `make` 21 | - Connect via the OTG USB socket for programming (you may need to be 22 | root for this): 23 | `make -C src/stm32f4-relay-96bcarbon flash` 24 | 25 | Hardware setup 26 | -------------- 27 | 28 | Connections requires are: 29 | 30 | - Connect via the UART USB socket and set the baud rate to 38400. 31 | - USB5V (pin 11) and GND (pin 9) to relay board 32 | - The relays should be connected using the pins allocated to LS-UART0 and 33 | LS-SPI0. This results in a 1:1 mapping between pin numbers and relay 34 | numbers; relay1 is pin 1 of the LS connector, relay 8 is pin 8 of the 35 | LS connector. 36 | 37 | Note: The Carbon port uses the onboard FDTI USB -> serial bridge rather 38 | than emulating a CDC-ACM device. On Linux it will be presented 39 | as /dev/ttyUSBx. 40 | 41 | Example session 42 | --------------- 43 | 44 | ~~~ 45 | > help 46 | Available commands: 47 | echo 48 | help 49 | led 50 | relay1 51 | relay2 52 | relay3 53 | relay4 54 | relay5 55 | relay6 56 | relay7 57 | relay8 58 | uptime 59 | > led on 60 | > led off 61 | > relay1 help 62 | Usage: relay1 on|off|toggle|pulse 63 | > relay1 toggle 64 | ~~~ 65 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | # 2 | # Linux kernel coding style 3 | # 4 | 5 | BasedOnStyle: LLVM 6 | IndentWidth: 8 7 | UseTab: Always 8 | BreakBeforeBraces: Linux 9 | AllowShortIfStatementsOnASingleLine: false 10 | IndentCaseLabels: false 11 | 12 | # 13 | # Reminder of some of the options (clang-format -style=llvm -dump-config | sed -e 's/^/#/') 14 | # 15 | #--- 16 | ## BasedOnStyle: LLVM 17 | #AccessModifierOffset: -2 18 | #ConstructorInitializerIndentWidth: 4 19 | #AlignEscapedNewlinesLeft: false 20 | #AlignTrailingComments: true 21 | #AllowAllParametersOfDeclarationOnNextLine: true 22 | #AllowShortIfStatementsOnASingleLine: false 23 | #AllowShortLoopsOnASingleLine: false 24 | #AlwaysBreakTemplateDeclarations: false 25 | #AlwaysBreakBeforeMultilineStrings: false 26 | #BreakBeforeBinaryOperators: false 27 | #BreakBeforeTernaryOperators: true 28 | #BreakConstructorInitializersBeforeComma: false 29 | #BinPackParameters: true 30 | #ColumnLimit: 80 31 | #ConstructorInitializerAllOnOneLineOrOnePerLine: false 32 | #DerivePointerBinding: false 33 | #ExperimentalAutoDetectBinPacking: false 34 | #IndentCaseLabels: false 35 | #MaxEmptyLinesToKeep: 1 36 | #NamespaceIndentation: None 37 | #ObjCSpaceBeforeProtocolList: true 38 | #PenaltyBreakBeforeFirstCallParameter: 19 39 | #PenaltyBreakComment: 60 40 | #PenaltyBreakString: 1000 41 | #PenaltyBreakFirstLessLess: 120 42 | #PenaltyExcessCharacter: 1000000 43 | #PenaltyReturnTypeOnItsOwnLine: 60 44 | #PointerBindsToType: false 45 | #SpacesBeforeTrailingComments: 1 46 | #Cpp11BracedListStyle: false 47 | #Standard: Cpp03 48 | #IndentWidth: 2 49 | #TabWidth: 8 50 | #UseTab: Never 51 | #BreakBeforeBraces: Attach 52 | #IndentFunctionDeclarationAfterType: false 53 | #SpacesInParentheses: false 54 | #SpacesInAngles: false 55 | #SpaceInEmptyParentheses: false 56 | #SpacesInCStyleCastParentheses: false 57 | #SpaceAfterControlStatementKeyword: true 58 | #SpaceBeforeAssignmentOperators: true 59 | #ContinuationIndentWidth: 4 60 | #... 61 | 62 | -------------------------------------------------------------------------------- /bin/targetctl: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # targetctl 5 | # 6 | # Use usb-relay to turn targets on/off 7 | # 8 | 9 | usage () { 10 | echo "Usage: targetctl on|off|reboot " >&2 11 | exit 1 12 | } 13 | 14 | # Load user preferences 15 | if ! [ -e $HOME/.targetctlrc ] 16 | then 17 | echo "ERROR: No configuration file found, check .targetctlrc" >&2 18 | cat > $HOME/.targetctlrc << EOF 19 | # 20 | # Example .targetctlrc 21 | # 22 | 23 | ## default_device can be used to set the default tty. This is only useful 24 | ## on systems that have only one usb-relay device attached. 25 | #default_device=/dev/ttyACM0 26 | 27 | ## _relay and _device are used to set the relay number and 28 | ## device for . If _device is omitted then the default_device 29 | ## will be used. 30 | #example_relay=1 31 | #example_device=/dev/ttyACM1 32 | 33 | ## Example configuration 34 | #default_device=/dev/ttyACM0 35 | #wandboard_relay=1 36 | ## relay2 is not connected 37 | ## relay3 is not connected 38 | #hikey_relay=4 39 | EOF 40 | exit 2 41 | fi 42 | . $HOME/.targetctlrc 43 | 44 | # Argument checking 45 | if [ $# -ne 2 ] 46 | then 47 | usage 48 | fi 49 | 50 | # Determine the action (or actions) to be taken 51 | case $1 in 52 | on) 53 | actions="on" 54 | ;; 55 | off) 56 | actions="off" 57 | ;; 58 | reboot) 59 | actions="on pulse" 60 | ;; 61 | *) 62 | usage 63 | ;; 64 | esac 65 | 66 | # Determine the device and relay to be selected 67 | device="$(eval echo \$${2}_device)" 68 | [ -z $device ] && device="$default_device" 69 | relay="$(eval echo \$${2}_relay)" 70 | invert="$(eval echo \$${2}_invert)" 71 | 72 | # Exchange on/off if the signal is inverted 73 | if [ "$invert" = "y" ] 74 | then 75 | case "$actions" in 76 | on) 77 | actions="off" 78 | ;; 79 | off) 80 | actions="on" 81 | ;; 82 | on?pulse) 83 | actions="off pulse" 84 | ;; 85 | esac 86 | fi 87 | 88 | # Prepend relay if needed 89 | case "$relay" in 90 | [0-9]*) 91 | relay=relay$relay 92 | ;; 93 | esac 94 | 95 | # Final sanity check 96 | if [ -z $device ] || [ -z $relay ] 97 | then 98 | echo "ERROR: Board $2 is not configured, check .targetctlrc" 99 | exit 3 100 | fi 101 | 102 | # Perform the actions 103 | for action in $actions 104 | do 105 | echo "$relay $action >> $device" 106 | echo "$relay $action" >> $device 107 | done 108 | -------------------------------------------------------------------------------- /src/stm32f4-relay/relay.c: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the usb-relay project. 3 | * 4 | * Copyright (C) 2014 Daniel Thompson 5 | * 6 | * This library is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU Lesser General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General Public License 17 | * along with this library. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | 30 | static console_t cdcacm_console; 31 | 32 | static pt_state_t do_uptime(console_t *c) 33 | { 34 | unsigned int hours, minutes, seconds, microseconds; 35 | 36 | uint64_t t = time64_now(); 37 | 38 | /* get to 32-bit values as directly as possible */ 39 | minutes = t / (60 * 1000000); 40 | microseconds = t % (60 * 1000000); 41 | 42 | hours = minutes / 60; 43 | minutes %= 60; 44 | seconds = microseconds / 1000000; 45 | microseconds %= 1000000; 46 | 47 | fprintf(c->out, "%02u:%02u:%02u.%03u\n", hours, minutes, seconds, 48 | microseconds / 1000); 49 | 50 | return PT_EXITED; 51 | } 52 | static const console_cmd_t cmd_uptime = 53 | CONSOLE_CMD_VAR_INIT("uptime", do_uptime); 54 | 55 | const console_gpio_t gpio_led = CONSOLE_GPIO_VAR_INIT("led", GPIOD, GPIO12, 0); 56 | 57 | const console_gpio_t gpio_relays[] = { 58 | CONSOLE_GPIO_VAR_INIT("relay1", GPIOD, GPIO8, console_gpio_open_drain), 59 | CONSOLE_GPIO_VAR_INIT("relay2", GPIOD, GPIO9, console_gpio_open_drain), 60 | CONSOLE_GPIO_VAR_INIT("relay3", GPIOD, GPIO10, console_gpio_open_drain), 61 | CONSOLE_GPIO_VAR_INIT("relay4", GPIOD, GPIO11, console_gpio_open_drain), 62 | }; 63 | 64 | int main(void) 65 | { 66 | rcc_clock_setup_hse_3v3(&rcc_hse_8mhz_3v3[RCC_CLOCK_3V3_120MHZ]); 67 | 68 | time_init(); 69 | console_init(&cdcacm_console, stdout); 70 | console_register(&cmd_uptime); 71 | 72 | console_gpio_register(&gpio_led); 73 | for (unsigned int i=0; i 5 | * 6 | * This library is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU Lesser General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General Public License 17 | * along with this library. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | 30 | static console_t uart_console; 31 | 32 | static pt_state_t do_uptime(console_t *c) 33 | { 34 | unsigned int hours, minutes, seconds, microseconds; 35 | 36 | uint64_t t = time64_now(); 37 | 38 | /* get to 32-bit values as directly as possible */ 39 | minutes = t / (60 * 1000000); 40 | microseconds = t % (60 * 1000000); 41 | 42 | hours = minutes / 60; 43 | minutes %= 60; 44 | seconds = microseconds / 1000000; 45 | microseconds %= 1000000; 46 | 47 | fprintf(c->out, "%02u:%02u:%02u.%03u\n", hours, minutes, seconds, 48 | microseconds / 1000); 49 | 50 | return PT_EXITED; 51 | } 52 | static const console_cmd_t cmd_uptime = 53 | CONSOLE_CMD_VAR_INIT("uptime", do_uptime); 54 | 55 | const console_gpio_t gpio_led = CONSOLE_GPIO_VAR_INIT("led", GPIOA, GPIO15, 0); 56 | 57 | const console_gpio_t gpio_relays[] = { 58 | CONSOLE_GPIO_VAR_INIT("relay1", GPIOA, GPIO0, console_gpio_open_drain), 59 | CONSOLE_GPIO_VAR_INIT("relay2", GPIOB, GPIO12, console_gpio_open_drain), 60 | CONSOLE_GPIO_VAR_INIT("relay3", GPIOA, GPIO2, console_gpio_open_drain), 61 | CONSOLE_GPIO_VAR_INIT("relay4", GPIOB, GPIO15, console_gpio_open_drain), 62 | CONSOLE_GPIO_VAR_INIT("relay5", GPIOA, GPIO3, console_gpio_open_drain), 63 | CONSOLE_GPIO_VAR_INIT("relay6", GPIOB, GPIO14, console_gpio_open_drain), 64 | CONSOLE_GPIO_VAR_INIT("relay7", GPIOA, GPIO1, console_gpio_open_drain), 65 | CONSOLE_GPIO_VAR_INIT("relay8", GPIOB, GPIO13, console_gpio_open_drain), 66 | }; 67 | 68 | int main(void) 69 | { 70 | rcc_clock_setup_hse_3v3(&rcc_hse_16mhz_3v3[RCC_CLOCK_3V3_84MHZ]); 71 | 72 | time_init(); 73 | console_init(&uart_console, stdout); 74 | console_register(&cmd_uptime); 75 | 76 | console_gpio_register(&gpio_led); 77 | for (unsigned int i=0; i 5 | ## 6 | ## This library is free software: you can redistribute it and/or modify 7 | ## it under the terms of the GNU Lesser General Public License as published by 8 | ## the Free Software Foundation, either version 3 of the License, or 9 | ## (at your option) any later version. 10 | ## 11 | ## This library is distributed in the hope that it will be useful, 12 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | ## GNU Lesser General Public License for more details. 15 | ## 16 | ## You should have received a copy of the GNU Lesser General Public License 17 | ## along with this library. If not, see . 18 | ## 19 | 20 | PREFIX ?= arm-none-eabi 21 | #PREFIX ?= arm-elf 22 | 23 | TARGETS := stm32/f0 stm32/f1 stm32/f4 24 | #TARGETS := stm32/f0 stm32/f1 stm32/f2 stm32/f3 stm32/f4 stm32/l1 25 | #TARGETS += lpc13xx lpc17xx #lpc43xx 26 | #TARGETS += lm3s lm4f 27 | #TARGETS += efm32/efm32tg efm32/efm32g efm32/efm32lg efm32/efm32gg 28 | 29 | # Be silent per default, but 'make V=1' will show all compiler calls. 30 | ifneq ($(V),1) 31 | Q := @ 32 | # Do not print "Entering directory ...". 33 | MAKEFLAGS += --no-print-directory 34 | endif 35 | 36 | OPENCM3_DIR := $(realpath libopencm3) 37 | EXAMPLE_RULES = elf 38 | 39 | all: build 40 | 41 | bin: EXAMPLE_RULES += bin 42 | hex: EXAMPLE_RULES += hex 43 | srec: EXAMPLE_RULES += srec 44 | list: EXAMPLE_RULES += list 45 | images: EXAMPLE_RULES += images 46 | 47 | bin: build 48 | hex: build 49 | srec: build 50 | list: build 51 | images: build 52 | 53 | build: libopencm3 examples 54 | 55 | libopencm3: 56 | $(Q)if [ ! "`ls -A libopencm3`" ] ; then \ 57 | printf "######## ERROR ########\n"; \ 58 | printf "\tlibopencm3 is not initialized.\n"; \ 59 | printf "\tPlease run:\n"; \ 60 | printf "\t$$ git submodule init\n"; \ 61 | printf "\t$$ git submodule update\n"; \ 62 | printf "\tbefore running make.\n"; \ 63 | printf "######## ERROR ########\n"; \ 64 | exit 1; \ 65 | fi 66 | $(Q)$(MAKE) -C libopencm3 TARGETS="$(TARGETS)" 67 | 68 | #EXAMPLE_DIRS:=$(sort $(dir $(wildcard $(addsuffix /*/*/Makefile,$(addprefix examples/,$(TARGETS)))))) 69 | EXAMPLE_DIRS := src/bootloader src/stm32f0-relay src/stm32f1-relay src/stm32f4-relay src/stm32f4-relay-96bcarbon 70 | $(EXAMPLE_DIRS): libopencm3 71 | @printf " BUILD $@\n"; 72 | $(Q)$(MAKE) --directory=$@ OPENCM3_DIR=$(OPENCM3_DIR) $(EXAMPLE_RULES) 73 | 74 | examples: $(EXAMPLE_DIRS) 75 | $(Q)true 76 | 77 | clean: $(EXAMPLE_DIRS:=.clean) 78 | $(Q)$(MAKE) -C libopencm3 clean 79 | 80 | stylecheck: $(EXAMPLE_DIRS:=.stylecheck) 81 | styleclean: $(EXAMPLE_DIRS:=.styleclean) 82 | 83 | 84 | %.clean: 85 | $(Q)if [ -d $* ]; then \ 86 | printf " CLEAN $*\n"; \ 87 | $(MAKE) -C $* clean OPENCM3_DIR=$(OPENCM3_DIR) || exit $?; \ 88 | fi; 89 | 90 | %.styleclean: 91 | $(Q)$(MAKE) -C $* styleclean OPENCM3_DIR=$(OPENCM3_DIR) 92 | 93 | %.stylecheck: 94 | $(Q)$(MAKE) -C $* stylecheck OPENCM3_DIR=$(OPENCM3_DIR) 95 | 96 | 97 | .PHONY: build libopencm3 examples $(EXAMPLE_DIRS) install clean \ 98 | stylecheck styleclean bin hex srec list images 99 | 100 | -------------------------------------------------------------------------------- /src/stm32f1-relay/relay.c: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the usb-relay project. 3 | * 4 | * Copyright (C) 2014 Daniel Thompson 5 | * 6 | * This library is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU Lesser General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General Public License 17 | * along with this library. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | 33 | static console_t cdcacm_console; 34 | 35 | static void jump_to_bootloader(void) 36 | { 37 | char * const marker = (char *)0x20004800; /* RAM@18K */ 38 | const char key[] = "remain-in-loader"; 39 | 40 | memcpy(marker, key, sizeof(key)); 41 | scb_reset_system(); /* Will never return. */ 42 | } 43 | 44 | static pt_state_t do_id(console_t *c) 45 | { 46 | char serial_no[25]; 47 | 48 | desig_get_unique_id_as_string(serial_no, sizeof(serial_no)); 49 | fprintf(c->out, "%s\n", serial_no); 50 | 51 | return PT_EXITED; 52 | } 53 | 54 | static pt_state_t do_reboot(console_t *c) 55 | { 56 | (void) c; 57 | jump_to_bootloader(); 58 | return PT_EXITED; 59 | } 60 | 61 | static pt_state_t do_uptime(console_t *c) 62 | { 63 | unsigned int hours, minutes, seconds, microseconds; 64 | 65 | uint64_t t = time64_now(); 66 | 67 | /* get to 32-bit values as directly as possible */ 68 | minutes = t / (60 * 1000000); 69 | microseconds = t % (60 * 1000000); 70 | 71 | hours = minutes / 60; 72 | minutes %= 60; 73 | seconds = microseconds / 1000000; 74 | microseconds %= 1000000; 75 | 76 | fprintf(c->out, "%02u:%02u:%02u.%03u\n", hours, minutes, seconds, 77 | microseconds / 1000); 78 | 79 | return PT_EXITED; 80 | } 81 | 82 | static pt_state_t do_version(console_t *c) 83 | { 84 | fprintf(c->out, "usb-relay version %s (%s %s)\n", VERSION, __DATE__, 85 | __TIME__); 86 | return PT_EXITED; 87 | } 88 | 89 | static const console_cmd_t cmds[] = { 90 | CONSOLE_CMD_VAR_INIT("id", do_id), 91 | CONSOLE_CMD_VAR_INIT("reboot", do_reboot), 92 | CONSOLE_CMD_VAR_INIT("uptime", do_uptime), 93 | CONSOLE_CMD_VAR_INIT("version", do_version) 94 | }; 95 | 96 | #define ON_WITH_OPEN_DRAIN (console_gpio_default_on | console_gpio_open_drain) 97 | #define ON_AND_ACTIVE_LOW (console_gpio_default_on | console_gpio_active_low) 98 | 99 | #ifdef CONFIG_PLATFORM_MINI_STLINK 100 | const console_gpio_t gpios[] = { 101 | /* 102 | * SWIM and SWCLK are connected to multiple pins (hence the 103 | * commented out alternatives below). There are few useful 104 | * peripherals whose alternative functions are attached to 105 | * these pins, although shorting PB9 with the neighbouring 106 | * PB8 pin does make I2C1 available on PB6 (RST) and PB9 107 | * (SWIM). 108 | */ 109 | CONSOLE_GPIO_VAR_INIT("rst", GPIOB, GPIO6, 0), // pulled down 110 | CONSOLE_GPIO_VAR_INIT("swdio", GPIOB, GPIO14, 0), // pulled up 111 | CONSOLE_GPIO_VAR_INIT("swim", GPIOB, GPIO8, 0), // pulled up 112 | //CONSOLE_GPIO_VAR_INIT("swim", GPIOB, GPIO11, 0), 113 | CONSOLE_GPIO_VAR_INIT("swclk", GPIOB, GPIO13, 0), // pulled up 114 | //CONSOLE_GPIO_VAR_INIT("swclk", GPIOA, GPIO5, 0), 115 | CONSOLE_GPIO_VAR_INIT("led", GPIOA, GPIO9, 0), 116 | }; 117 | 118 | #else 119 | const console_gpio_t gpios[] = { 120 | CONSOLE_GPIO_VAR_INIT("relay1", GPIOB, GPIO12, ON_WITH_OPEN_DRAIN), 121 | CONSOLE_GPIO_VAR_INIT("relay2", GPIOB, GPIO13, ON_WITH_OPEN_DRAIN), 122 | CONSOLE_GPIO_VAR_INIT("relay3", GPIOB, GPIO14, ON_WITH_OPEN_DRAIN), 123 | CONSOLE_GPIO_VAR_INIT("relay4", GPIOB, GPIO15, ON_WITH_OPEN_DRAIN), 124 | CONSOLE_GPIO_VAR_INIT("relay5", GPIOA, GPIO8, ON_WITH_OPEN_DRAIN), 125 | CONSOLE_GPIO_VAR_INIT("relay6", GPIOA, GPIO9, ON_WITH_OPEN_DRAIN), 126 | CONSOLE_GPIO_VAR_INIT("relay7", GPIOA, GPIO10, ON_WITH_OPEN_DRAIN), 127 | CONSOLE_GPIO_VAR_INIT("relay8", GPIOB, GPIO6, ON_WITH_OPEN_DRAIN), 128 | CONSOLE_GPIO_VAR_INIT("led", GPIOC, GPIO13, console_gpio_active_low | 129 | console_gpio_default_on), 130 | }; 131 | #endif 132 | 133 | #ifdef CONFIG_PLATFORM_MINI_STLINK 134 | static int blink_fibre(fibre_t *fibre) 135 | { 136 | static int i; 137 | static int32_t time; 138 | 139 | PT_BEGIN_FIBRE(fibre); 140 | 141 | rcc_periph_clock_enable(RCC_GPIOA); 142 | 143 | time = time_now(); 144 | for (i = 0; i < 16; i++) { 145 | gpio_toggle(GPIOA, GPIO9); 146 | 147 | time += 100000; 148 | PT_WAIT_UNTIL(fibre_timeout(time)); 149 | } 150 | 151 | PT_END(); 152 | } 153 | static fibre_t blink_task = FIBRE_VAR_INIT(blink_fibre); 154 | #endif 155 | 156 | int main(void) 157 | { 158 | rcc_clock_setup_in_hse_8mhz_out_72mhz(); 159 | 160 | time_init(); 161 | 162 | console_init(&cdcacm_console, stdout); 163 | for (unsigned int i=0; i 5 | * 6 | * This library is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU Lesser General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General Public License 17 | * along with this library. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | 34 | static console_t cdcacm_console; 35 | 36 | const console_gpio_t gpio_relays[] = { 37 | CONSOLE_GPIO_VAR_INIT("power", GPIOB, GPIO5, 38 | console_gpio_open_drain | console_gpio_active_low), 39 | CONSOLE_GPIO_VAR_INIT("reset", GPIOB, GPIO4, 40 | console_gpio_active_low), 41 | CONSOLE_GPIO_VAR_INIT("recovery", GPIOA, GPIO15, 42 | console_gpio_open_drain | console_gpio_active_low), 43 | }; 44 | 45 | /* 46 | * For I4 atomic fetch actions the compiler (according to the gcc diagnostics 47 | * expects 'unsigned int(volatile void *, unsigned int, int) 48 | */ 49 | 50 | #define I1 unsigned char 51 | #define I4 unsigned int 52 | 53 | #define ATOMIC_FETCH(width, action, operator) \ 54 | I##width __atomic_fetch_##action##_##width(volatile void *mem, \ 55 | I##width arg, int model) \ 56 | { \ 57 | volatile I##width *ptr = mem; \ 58 | I##width oldval; \ 59 | (void)model; \ 60 | \ 61 | CM_ATOMIC_BLOCK() \ 62 | { \ 63 | oldval = *ptr; \ 64 | *ptr = oldval operator arg; \ 65 | } \ 66 | \ 67 | return oldval; \ 68 | } 69 | 70 | #define ATOMIC_COMPARE_EXCHANGE(width) \ 71 | bool __atomic_compare_exchange_##width( \ 72 | volatile void *mem, void *expected, I##width desired, bool weak, \ 73 | int success_memorder, int failure_memorder) \ 74 | { \ 75 | volatile I##width *ptr = mem; \ 76 | I##width *exp = expected; \ 77 | (void)weak; \ 78 | (void)success_memorder; \ 79 | (void)failure_memorder; \ 80 | \ 81 | CM_ATOMIC_BLOCK() \ 82 | { \ 83 | I##width actual = *ptr; \ 84 | if (actual != *exp) { \ 85 | *exp = actual; \ 86 | return false; \ 87 | } \ 88 | *ptr = desired; \ 89 | } \ 90 | \ 91 | return true; \ 92 | } 93 | 94 | ATOMIC_FETCH(4, or, |) 95 | ATOMIC_FETCH(4, and, &) 96 | ATOMIC_FETCH(1, add, +) 97 | ATOMIC_FETCH(1, sub, -) 98 | 99 | ATOMIC_COMPARE_EXCHANGE(1) 100 | 101 | #undef stdout 102 | FILE *stdout = (void *) 1; 103 | int _write(int fd, const char *ptr, int len); 104 | 105 | int fprintf(FILE *f, const char *fmt, ...) 106 | { 107 | va_list ap; 108 | 109 | va_start(ap, fmt); 110 | 111 | while (*fmt) { 112 | switch (*fmt) { 113 | case '%': 114 | fmt++; 115 | if (*fmt == 's') { 116 | fputs(va_arg(ap, char *), f); 117 | fmt++; 118 | } else { 119 | fputc(*fmt++, f); 120 | } 121 | break; 122 | default: 123 | fputc(*fmt++, f); 124 | } 125 | } 126 | 127 | va_end(ap); 128 | 129 | 130 | /* 131 | * nobody checks the return value of printf()... so let's not 132 | * waste time being standards compliant... 133 | */ 134 | return 0; 135 | }; 136 | 137 | int fputc(int c, FILE *f) 138 | { 139 | char ch = c; 140 | return _write((int) f, &ch, 1); 141 | } 142 | 143 | int fputs(const char *s, FILE *f) 144 | { 145 | return _write((int) f, s, strlen(s)); 146 | } 147 | 148 | int fflush(FILE *stream) 149 | { 150 | (void) stream; 151 | return 0; 152 | } 153 | 154 | int main(void) 155 | { 156 | rcc_clock_setup_in_hsi_out_48mhz(); 157 | crs_autotrim_usb_enable(); 158 | rcc_set_usbclk_source(RCC_HSI48); 159 | 160 | // Accomodate USB using (shared) pins PA11 and PA12 161 | rcc_periph_clock_enable(RCC_SYSCFG_COMP); 162 | SYSCFG_CFGR1 |= SYSCFG_CFGR1_PA11_PA12_RMP; 163 | 164 | time_init(); 165 | console_init(&cdcacm_console, stdout); 166 | 167 | for (unsigned int i=0; i 5 | ## Copyright (C) 2010 Piotr Esden-Tempski 6 | ## Copyright (C) 2013 Frantisek Burian 7 | ## 8 | ## This library is free software: you can redistribute it and/or modify 9 | ## it under the terms of the GNU Lesser General Public License as published by 10 | ## the Free Software Foundation, either version 3 of the License, or 11 | ## (at your option) any later version. 12 | ## 13 | ## This library is distributed in the hope that it will be useful, 14 | ## but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | ## GNU Lesser General Public License for more details. 17 | ## 18 | ## You should have received a copy of the GNU Lesser General Public License 19 | ## along with this library. If not, see . 20 | ## 21 | 22 | # Be silent per default, but 'make V=1' will show all compiler calls. 23 | ifneq ($(V),1) 24 | Q := @ 25 | NULL := 2>/dev/null 26 | endif 27 | 28 | ############################################################################### 29 | # Executables 30 | 31 | PREFIX ?= arm-none-eabi 32 | 33 | CC := $(PREFIX)-gcc 34 | CXX := $(PREFIX)-g++ 35 | LD := $(PREFIX)-gcc 36 | AR := $(PREFIX)-ar 37 | AS := $(PREFIX)-as 38 | OBJCOPY := $(PREFIX)-objcopy 39 | OBJDUMP := $(PREFIX)-objdump 40 | GDB := $(PREFIX)-gdb 41 | STFLASH = $(shell which st-flash) 42 | STYLECHECK := /checkpatch.pl 43 | STYLECHECKFLAGS := --no-tree -f --terse --mailback 44 | STYLECHECKFILES := $(shell find . -name '*.[ch]') 45 | 46 | 47 | ############################################################################### 48 | # Source files 49 | 50 | LDSCRIPT ?= $(BINARY).ld 51 | 52 | OBJS += $(BINARY).o 53 | 54 | 55 | ifeq ($(strip $(OPENCM3_DIR)),) 56 | # user has not specified the library path, so we try to detect it 57 | 58 | # where we search for the library 59 | LIBPATHS := ./libopencm3 ../../libopencm3 ../../../../libopencm3 ../../../../../libopencm3 60 | 61 | OPENCM3_DIR := $(wildcard $(LIBPATHS:=/locm3.sublime-project)) 62 | OPENCM3_DIR := $(firstword $(dir $(OPENCM3_DIR))) 63 | 64 | ifeq ($(strip $(OPENCM3_DIR)),) 65 | $(warning Cannot find libopencm3 library in the standard search paths.) 66 | $(error Please specify it through OPENCM3_DIR variable!) 67 | endif 68 | endif 69 | 70 | ifeq ($(V),1) 71 | $(info Using $(OPENCM3_DIR) path to library) 72 | endif 73 | 74 | INCLUDE_DIR = $(OPENCM3_DIR)/include 75 | LIB_DIR = $(OPENCM3_DIR)/lib 76 | SCRIPT_DIR = $(OPENCM3_DIR)/scripts 77 | 78 | ############################################################################### 79 | # C flags 80 | 81 | CFLAGS += -Os -g 82 | CFLAGS += -std=gnu99 83 | CFLAGS += -Wextra -Wshadow -Wimplicit-function-declaration 84 | CFLAGS += -Wredundant-decls -Wmissing-prototypes -Wstrict-prototypes 85 | CFLAGS += -fno-common -ffunction-sections -fdata-sections 86 | 87 | ############################################################################### 88 | # C++ flags 89 | 90 | CXXFLAGS += -Os -g 91 | CXXFLAGS += -Wextra -Wshadow -Wredundant-decls -Weffc++ 92 | CXXFLAGS += -fno-common -ffunction-sections -fdata-sections 93 | 94 | ############################################################################### 95 | # C & C++ preprocessor common flags 96 | 97 | CPPFLAGS += -MD 98 | CPPFLAGS += -Wall -Wundef 99 | CPPFLAGS += -I$(INCLUDE_DIR) $(DEFS) 100 | CPPFLAGS += -DVERSION='"$(shell git describe --tags --dirty=+ || echo UNKNOWN)"' 101 | 102 | ############################################################################### 103 | # Linker flags 104 | 105 | LDFLAGS += --static -nostartfiles 106 | LDFLAGS += -L$(LIB_DIR) 107 | LDFLAGS += -T$(LDSCRIPT) 108 | LDFLAGS += -Wl,-Map=$(*).map 109 | LDFLAGS += -Wl,--gc-sections 110 | ifeq ($(V),99) 111 | LDFLAGS += -Wl,--print-gc-sections 112 | endif 113 | 114 | ############################################################################### 115 | # Used libraries 116 | 117 | LDLIBS += -l$(LIBNAME) 118 | LDLIBS += -Wl,--start-group -lc -lgcc -lnosys -Wl,--end-group 119 | 120 | ############################################################################### 121 | ############################################################################### 122 | ############################################################################### 123 | 124 | .SUFFIXES: .elf .bin .hex .srec .list .map .images 125 | .SECONDEXPANSION: 126 | .SECONDARY: 127 | 128 | all: elf 129 | 130 | elf: $(BINARY).elf 131 | bin: $(BINARY).bin 132 | hex: $(BINARY).hex 133 | srec: $(BINARY).srec 134 | list: $(BINARY).list 135 | 136 | images: $(BINARY).images 137 | flash: $(BINARY).flash 138 | 139 | %.images: %.bin %.hex %.srec %.list %.map 140 | @#printf "*** $* images generated ***\n" 141 | 142 | %.bin: %.elf 143 | @#printf " OBJCOPY $(*).bin\n" 144 | $(Q)$(OBJCOPY) -Obinary $(*).elf $(*).bin 145 | 146 | %.hex: %.elf 147 | @#printf " OBJCOPY $(*).hex\n" 148 | $(Q)$(OBJCOPY) -Oihex $(*).elf $(*).hex 149 | 150 | %.srec: %.elf 151 | @#printf " OBJCOPY $(*).srec\n" 152 | $(Q)$(OBJCOPY) -Osrec $(*).elf $(*).srec 153 | 154 | %.list: %.elf 155 | @#printf " OBJDUMP $(*).list\n" 156 | $(Q)$(OBJDUMP) -S $(*).elf > $(*).list 157 | 158 | $(BINARY).elf $(BINARY).map: $(OBJS) $(LDSCRIPT) $(LIB_DIR)/lib$(LIBNAME).a 159 | @printf " LD $(*).elf\n" 160 | $(Q)$(LD) $(LDFLAGS) $(ARCH_FLAGS) $(OBJS) $(LDLIBS) -o $(*).elf 161 | 162 | %.o: %.c 163 | @printf " CC $(*).c\n" 164 | $(Q)$(CC) $(CFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $@ -c $< 165 | 166 | %.o: %.cxx 167 | @printf " CXX $(*).cxx\n" 168 | $(Q)$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $(*).o -c $(*).cxx 169 | 170 | %.o: %.cpp 171 | @printf " CXX $(*).cpp\n" 172 | $(Q)$(CXX) $(CXXFLAGS) $(CPPFLAGS) $(ARCH_FLAGS) -o $(*).o -c $(*).cpp 173 | 174 | clean: 175 | @#printf " CLEAN\n" 176 | $(Q)$(RM) *.o *.d *.elf *.bin *.hex *.srec *.list *.map 177 | 178 | stylecheck: $(STYLECHECKFILES:=.stylecheck) 179 | styleclean: $(STYLECHECKFILES:=.styleclean) 180 | 181 | # the cat is due to multithreaded nature - we like to have consistent chunks of text on the output 182 | %.stylecheck: % 183 | $(Q)$(SCRIPT_DIR)$(STYLECHECK) $(STYLECHECKFLAGS) $* > $*.stylecheck; \ 184 | if [ -s $*.stylecheck ]; then \ 185 | cat $*.stylecheck; \ 186 | else \ 187 | rm -f $*.stylecheck; \ 188 | fi; 189 | 190 | %.styleclean: 191 | $(Q)rm -f $*.stylecheck; 192 | 193 | 194 | %.stlink-flash: %.bin 195 | @printf " FLASH $<\n" 196 | $(Q)$(STFLASH) write $(*).bin 0x8000000 197 | 198 | ifeq ($(STLINK_PORT),) 199 | ifeq ($(BMP_PORT),) 200 | ifeq ($(OOCD_SERIAL),) 201 | ifeq ($(DFU_ADDRESS),) 202 | %.flash: %.hex 203 | @printf " FLASH $<\n" 204 | @# IMPORTANT: Don't use "resume", only "reset" will work correctly! 205 | $(Q)$(OOCD) -f interface/$(OOCD_INTERFACE).cfg \ 206 | -f $(OOCD_BOARD).cfg \ 207 | -c "init" -c "reset init" \ 208 | -c "flash write_image erase $(*).hex" \ 209 | -c "reset" \ 210 | -c "shutdown" $(NULL) 211 | else 212 | %.flash: %.bin 213 | @printf " FLASH $<\n" 214 | $(Q)dfu-util -a 0 -d 0483:df11 -s $(DFU_ADDRESS):leave -D $(*).bin 215 | endif 216 | else 217 | %.flash: %.hex 218 | @printf " FLASH $<\n" 219 | @# IMPORTANT: Don't use "resume", only "reset" will work correctly! 220 | $(Q)$(OOCD) -f interface/$(OOCD_INTERFACE).cfg \ 221 | -f board/$(OOCD_BOARD).cfg \ 222 | -c "ft2232_serial $(OOCD_SERIAL)" \ 223 | -c "init" -c "reset init" \ 224 | -c "flash write_image erase $(*).hex" \ 225 | -c "reset" \ 226 | -c "shutdown" $(NULL) 227 | endif 228 | else 229 | %.flash: %.elf 230 | @printf " GDB $(*).elf (flash)\n" 231 | $(Q)$(GDB) --batch \ 232 | -ex 'target extended-remote $(BMP_PORT)' \ 233 | -x ../../mk/black_magic_probe_flash.scr \ 234 | $(*).elf 235 | endif 236 | else 237 | %.flash: %.elf 238 | @printf " GDB $(*).elf (flash)\n" 239 | $(Q)$(GDB) --batch \ 240 | -ex 'target extended-remote $(STLINK_PORT)' \ 241 | -x $(SCRIPT_DIR)/stlink_flash.scr \ 242 | $(*).elf 243 | endif 244 | 245 | .PHONY: images clean stylecheck styleclean elf bin hex srec list 246 | 247 | -include $(OBJS:.o=.d) 248 | -------------------------------------------------------------------------------- /src/bootloader/usbdfu.c: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is part of the usb-relay project. 3 | * 4 | * Copyright (C) 2010 Gareth McMullin 5 | * Copyright (C) 2014 Daniel Thompson 6 | * 7 | * This library is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU Lesser General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This library is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU Lesser General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU Lesser General Public License 18 | * along with this library. If not, see . 19 | */ 20 | 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | 31 | #define APP_ADDRESS 0x08002000 32 | 33 | /* Commands sent with wBlockNum == 0 as per ST implementation. */ 34 | #define CMD_SETADDR 0x21 35 | #define CMD_ERASE 0x41 36 | 37 | /* We need a special large control buffer for this device: */ 38 | uint8_t usbd_control_buffer[1024]; 39 | 40 | static enum dfu_state usbdfu_state = STATE_DFU_IDLE; 41 | 42 | static struct { 43 | uint8_t buf[sizeof(usbd_control_buffer)]; 44 | uint16_t len; 45 | uint32_t addr; 46 | uint16_t blocknum; 47 | } prog; 48 | 49 | const struct usb_device_descriptor dev = { 50 | .bLength = USB_DT_DEVICE_SIZE, 51 | .bDescriptorType = USB_DT_DEVICE, 52 | .bcdUSB = 0x0200, 53 | .bDeviceClass = 0, 54 | .bDeviceSubClass = 0, 55 | .bDeviceProtocol = 0, 56 | .bMaxPacketSize0 = 64, 57 | .idVendor = 0x0483, 58 | .idProduct = 0xDF11, 59 | .bcdDevice = 0x0200, 60 | .iManufacturer = 1, 61 | .iProduct = 2, 62 | .iSerialNumber = 3, 63 | .bNumConfigurations = 1, 64 | }; 65 | 66 | const struct usb_dfu_descriptor dfu_function = { 67 | .bLength = sizeof(struct usb_dfu_descriptor), 68 | .bDescriptorType = DFU_FUNCTIONAL, 69 | .bmAttributes = USB_DFU_CAN_DOWNLOAD | USB_DFU_WILL_DETACH, 70 | .wDetachTimeout = 255, 71 | .wTransferSize = 1024, 72 | .bcdDFUVersion = 0x011A, 73 | }; 74 | 75 | const struct usb_interface_descriptor iface = { 76 | .bLength = USB_DT_INTERFACE_SIZE, 77 | .bDescriptorType = USB_DT_INTERFACE, 78 | .bInterfaceNumber = 0, 79 | .bAlternateSetting = 0, 80 | .bNumEndpoints = 0, 81 | .bInterfaceClass = 0xFE, /* Device Firmware Upgrade */ 82 | .bInterfaceSubClass = 1, 83 | .bInterfaceProtocol = 2, 84 | 85 | /* The ST Microelectronics DfuSe application needs this string. 86 | * The format isn't documented... */ 87 | .iInterface = 4, 88 | 89 | .extra = &dfu_function, 90 | .extralen = sizeof(dfu_function), 91 | }; 92 | 93 | const struct usb_interface ifaces[] = {{ 94 | .num_altsetting = 1, 95 | .altsetting = &iface, 96 | }}; 97 | 98 | const struct usb_config_descriptor config = { 99 | .bLength = USB_DT_CONFIGURATION_SIZE, 100 | .bDescriptorType = USB_DT_CONFIGURATION, 101 | .wTotalLength = 0, 102 | .bNumInterfaces = 1, 103 | .bConfigurationValue = 1, 104 | .iConfiguration = 0, 105 | .bmAttributes = 0xC0, 106 | .bMaxPower = 0x32, 107 | 108 | .interface = ifaces, 109 | }; 110 | 111 | static const char *usb_strings[] = { 112 | "redfelineninja.org.uk", 113 | #ifdef CONFIG_PLATFORM_MINI_STLINK 114 | "DFU bootloader for Mini STLink", 115 | #else 116 | "DFU bootloader", 117 | #endif 118 | "v1.5", 119 | /* This string is used by ST Microelectronics' DfuSe utility. */ 120 | "@Internal Flash /0x08000000/8*001Ka,56*001Kg", 121 | }; 122 | 123 | static uint8_t usbdfu_getstatus(usbd_device *usbd_dev, uint32_t *bwPollTimeout) 124 | { 125 | (void)usbd_dev; 126 | 127 | switch (usbdfu_state) { 128 | case STATE_DFU_DNLOAD_SYNC: 129 | usbdfu_state = STATE_DFU_DNBUSY; 130 | *bwPollTimeout = 100; 131 | return DFU_STATUS_OK; 132 | case STATE_DFU_MANIFEST_SYNC: 133 | /* Device will reset when read is complete. */ 134 | usbdfu_state = STATE_DFU_MANIFEST; 135 | return DFU_STATUS_OK; 136 | default: 137 | return DFU_STATUS_OK; 138 | } 139 | } 140 | 141 | static void usbdfu_getstatus_complete(usbd_device *usbd_dev, struct usb_setup_data *req) 142 | { 143 | int i; 144 | (void)req; 145 | (void)usbd_dev; 146 | 147 | switch (usbdfu_state) { 148 | case STATE_DFU_DNBUSY: 149 | flash_unlock(); 150 | if (prog.blocknum == 0) { 151 | switch (prog.buf[0]) { 152 | case CMD_ERASE: 153 | { 154 | uint32_t *dat = (uint32_t *)(prog.buf + 1); 155 | flash_erase_page(*dat); 156 | } 157 | break; 158 | case CMD_SETADDR: 159 | { 160 | uint32_t *dat = (uint32_t *)(prog.buf + 1); 161 | prog.addr = *dat; 162 | } 163 | break; 164 | } 165 | } else { 166 | uint32_t baseaddr = prog.addr + ((prog.blocknum - 2) * 167 | dfu_function.wTransferSize); 168 | for (i = 0; i < prog.len; i += 2) { 169 | uint16_t *dat = (uint16_t *)(prog.buf + i); 170 | flash_program_half_word(baseaddr + i, 171 | *dat); 172 | } 173 | } 174 | flash_lock(); 175 | 176 | /* Jump straight to dfuDNLOAD-IDLE, skipping dfuDNLOAD-SYNC. */ 177 | usbdfu_state = STATE_DFU_DNLOAD_IDLE; 178 | return; 179 | case STATE_DFU_MANIFEST: 180 | /* USB device must detach, we just reset... */ 181 | scb_reset_system(); 182 | return; /* Will never return. */ 183 | default: 184 | return; 185 | } 186 | } 187 | 188 | static enum usbd_request_return_codes usbdfu_control_request(usbd_device *usbd_dev, struct usb_setup_data *req, uint8_t **buf, 189 | uint16_t *len, usbd_control_complete_callback *complete) 190 | { 191 | if ((req->bmRequestType & 0x7F) != 0x21) 192 | return USBD_REQ_NOTSUPP; /* Only accept class request. */ 193 | 194 | switch (req->bRequest) { 195 | case DFU_DNLOAD: 196 | if ((len == NULL) || (*len == 0)) { 197 | usbdfu_state = STATE_DFU_MANIFEST_SYNC; 198 | } else { 199 | /* Copy download data for use on GET_STATUS. */ 200 | prog.blocknum = req->wValue; 201 | prog.len = *len; 202 | memcpy(prog.buf, *buf, *len); 203 | usbdfu_state = STATE_DFU_DNLOAD_SYNC; 204 | } 205 | return USBD_REQ_HANDLED; 206 | case DFU_CLRSTATUS: 207 | /* Clear error and return to dfuIDLE. */ 208 | if (usbdfu_state == STATE_DFU_ERROR) 209 | usbdfu_state = STATE_DFU_IDLE; 210 | return USBD_REQ_HANDLED; 211 | case DFU_ABORT: 212 | /* Abort returns to dfuIDLE state. */ 213 | usbdfu_state = STATE_DFU_IDLE; 214 | return USBD_REQ_HANDLED; 215 | case DFU_UPLOAD: 216 | /* Upload not supported for now. */ 217 | return USBD_REQ_NOTSUPP; 218 | case DFU_GETSTATUS: { 219 | uint32_t bwPollTimeout = 0; /* 24-bit integer in DFU class spec */ 220 | (*buf)[0] = usbdfu_getstatus(usbd_dev, &bwPollTimeout); 221 | (*buf)[1] = bwPollTimeout & 0xFF; 222 | (*buf)[2] = (bwPollTimeout >> 8) & 0xFF; 223 | (*buf)[3] = (bwPollTimeout >> 16) & 0xFF; 224 | (*buf)[4] = usbdfu_state; 225 | (*buf)[5] = 0; /* iString not used here */ 226 | *len = 6; 227 | *complete = usbdfu_getstatus_complete; 228 | return USBD_REQ_HANDLED; 229 | } 230 | case DFU_GETSTATE: 231 | /* Return state with no state transision. */ 232 | *buf[0] = usbdfu_state; 233 | *len = 1; 234 | return USBD_REQ_HANDLED; 235 | } 236 | 237 | return USBD_REQ_NOTSUPP; 238 | } 239 | 240 | static usbd_device *usb_init(void) 241 | { 242 | uint32_t t; 243 | usbd_device *usb_dev; 244 | 245 | rcc_periph_clock_enable(RCC_GPIOA); 246 | 247 | /* lower hotplug and leave enough time for the host to notice */ 248 | gpio_set_mode(GPIOA, GPIO_MODE_OUTPUT_2_MHZ, GPIO_CNF_OUTPUT_PUSHPULL, 249 | GPIO11 | GPIO12); 250 | gpio_clear(GPIOA, GPIO11 || GPIO12); 251 | t = time_now() + 10000; 252 | while (cyclecmp32(time_now(), t) < 0) 253 | ; 254 | 255 | usb_dev = 256 | usbd_init(&st_usbfs_v1_usb_driver, &dev, &config, usb_strings, 4, 257 | usbd_control_buffer, sizeof(usbd_control_buffer)); 258 | usbd_register_control_callback( 259 | usb_dev, USB_REQ_TYPE_CLASS | USB_REQ_TYPE_INTERFACE, 260 | USB_REQ_TYPE_TYPE | USB_REQ_TYPE_RECIPIENT, usbdfu_control_request); 261 | 262 | return usb_dev; 263 | } 264 | 265 | int main(void) 266 | { 267 | const char key[] = "remain-in-loader"; 268 | const char anti_key[] = "leave-loader-now"; 269 | 270 | char * const marker = (char *)0x20004800; /* RAM@18K */ 271 | bool found_key, found_anti_key, found_pin_reset; 272 | usbd_device *usb_dev; 273 | 274 | /* Check and clear the marker value */ 275 | found_key = (0 == strcmp(marker, key)); 276 | found_anti_key = (0 == strcmp(marker, anti_key)); 277 | memset(marker, 0, sizeof(key)); 278 | 279 | #ifdef CONFIG_PLATFORM_MINI_STLINK 280 | /* This platform doesn't have a reset button so we must detect 281 | * a pattern on the GPIO pins (which are pulled up by default 282 | * but can be pulled down using jumper cables) 283 | */ 284 | rcc_periph_clock_enable(RCC_GPIOB); 285 | found_pin_reset = !gpio_get(GPIOB, GPIO8 | GPIO13); 286 | #else 287 | /* Check reset reason and clear it. Note that we can only clear 288 | * the reset reason in the bootloader because we know the application 289 | * doesn't use it. 290 | */ 291 | found_pin_reset = 292 | (RCC_CSR & RCC_CSR_PINRSTF) && 293 | !(RCC_CSR & (RCC_CSR_LPWRRSTF | RCC_CSR_WWDGRSTF | 294 | RCC_CSR_IWDGRSTF | RCC_CSR_SFTRSTF | RCC_CSR_PORRSTF)); 295 | RCC_CSR |= RCC_CSR_RMVF; 296 | #endif 297 | 298 | if ((!found_key && !found_pin_reset) || found_anti_key) { 299 | /* Boot the application if it's valid. */ 300 | if ((*(volatile uint32_t *)APP_ADDRESS & 0x2FFE0000) == 0x20000000) { 301 | /* Set vector table base address. */ 302 | SCB_VTOR = APP_ADDRESS & 0xFFFF; 303 | /* Initialise master stack pointer. */ 304 | asm volatile("msr msp, %0"::"g" 305 | (*(volatile uint32_t *)APP_ADDRESS)); 306 | /* Jump to application. */ 307 | (*(void (**)())(APP_ADDRESS + 4))(); 308 | } 309 | } 310 | 311 | rcc_clock_setup_in_hsi_out_48mhz(); 312 | 313 | /* set the anti-key so that the next reset causes us to leave the 314 | * bootloader if there is a valid application flashed 315 | */ 316 | memcpy(marker, anti_key, sizeof(anti_key)); 317 | 318 | time_init(); 319 | usb_dev = usb_init(); 320 | 321 | while (1) 322 | usbd_poll(usb_dev); 323 | } 324 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | 676 | --------------------------------------------------------------------------------