From bb98de2ebf7116ce3f68bc1d5ef6cd3e4cdf9629 Mon Sep 17 00:00:00 2001 From: Adrian Weber Date: Tue, 11 Feb 2020 10:25:51 +0100 Subject: [PATCH] Init Commit of RICH DCDC Firmware. Has already basic function for UART,ADC,Shift register. --- atmega32u4/dcdc_rich/Makefile | 230 ++++++++ atmega32u4/dcdc_rich/README.md | 51 ++ atmega32u4/dcdc_rich/main.c | 412 +++++++++++++ atmega32u4/dcdc_rich/usb_serial.c | 937 ++++++++++++++++++++++++++++++ atmega32u4/dcdc_rich/usb_serial.h | 124 ++++ 5 files changed, 1754 insertions(+) create mode 100644 atmega32u4/dcdc_rich/Makefile create mode 100644 atmega32u4/dcdc_rich/README.md create mode 100644 atmega32u4/dcdc_rich/main.c create mode 100644 atmega32u4/dcdc_rich/usb_serial.c create mode 100644 atmega32u4/dcdc_rich/usb_serial.h diff --git a/atmega32u4/dcdc_rich/Makefile b/atmega32u4/dcdc_rich/Makefile new file mode 100644 index 0000000..8ee15d8 --- /dev/null +++ b/atmega32u4/dcdc_rich/Makefile @@ -0,0 +1,230 @@ +# Hey Emacs, this is a -*- makefile -*- + +# AVR-GCC Makefile template, derived from the WinAVR template (which +# is public domain), believed to be neutral to any flavor of "make" +# (GNU make, BSD make, SysV make) + + +MCU = atmega32u4 +FORMAT = ihex +TARGET = main +SRC = $(TARGET).c usb_serial.c +ASRC = +OPT = 2 +PORT=/dev/ttyACM0 + +# Name of this Makefile (used for "make depend"). +MAKEFILE = Makefile + +# Debugging format. +# Native formats for AVR-GCC's -g are stabs [default], or dwarf-2. +# AVR (extended) COFF requires stabs, plus an avr-objcopy run. +DEBUG = stabs + +# Compiler flag to set the C Standard level. +# c89 - "ANSI" C +# gnu89 - c89 plus GCC extensions +# c99 - ISO C99 standard (not yet fully implemented) +# gnu99 - c99 plus GCC extensions +CSTANDARD = -std=gnu99 + +# Place -D or -U options here +CDEFS = -DF_CPU=8000000 + +# Place -I options here +CINCS = + + +CDEBUG = -g$(DEBUG) +CWARN = -Wall -Wstrict-prototypes +CTUNING = -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums -Wl,--relax +#CEXTRA = -Wa,-adhlns=$(<:.c=.lst) +CFLAGS = $(CDEBUG) $(CDEFS) $(CINCS) -O$(OPT) $(CWARN) $(CSTANDARD) $(CEXTRA) $(CTUNING) -DSTR_SERIAL_NUMBER=L\"$(NUMBER)\" + + +#ASFLAGS = -Wa,-adhlns=$(<:.S=.lst),-gstabs + + +#Additional libraries. + +# Minimalistic printf version +PRINTF_LIB_MIN = -Wl,-u,vfprintf -lprintf_min + +# Floating point printf version (requires MATH_LIB = -lm below) +PRINTF_LIB_FLOAT = -Wl,-u,vfprintf -lprintf_flt + +PRINTF_LIB = + +# Minimalistic scanf version +SCANF_LIB_MIN = -Wl,-u,vfscanf -lscanf_min + +# Floating point + %[ scanf version (requires MATH_LIB = -lm below) +SCANF_LIB_FLOAT = -Wl,-u,vfscanf -lscanf_flt + +SCANF_LIB = + +MATH_LIB = -lm + +# External memory options + +# 64 KB of external RAM, starting after internal RAM (ATmega128!), +# used for variables (.data/.bss) and heap (malloc()). +#EXTMEMOPTS = -Wl,--section-start,.data=0x801100,--defsym=__heap_end=0x80ffff + +# 64 KB of external RAM, starting after internal RAM (ATmega128!), +# only used for heap (malloc()). +#EXTMEMOPTS = -Wl,--defsym=__heap_start=0x801100,--defsym=__heap_end=0x80ffff + +EXTMEMOPTS = + +#LDMAP = $(LDFLAGS) -Wl,-Map=$(TARGET).map,--cref +LDFLAGS = $(EXTMEMOPTS) $(LDMAP) $(PRINTF_LIB) $(SCANF_LIB) $(MATH_LIB) + + +# Programming support using avrdude. Settings and variables. + +AVRDUDE_PROGRAMMER = dragon_jtag +AVRDUDE_PORT = usb + +AVRDUDE_WRITE_FLASH = -U flash:w:$(TARGET).hex +#AVRDUDE_WRITE_EEPROM = -U eeprom:w:$(TARGET).eep + + +# Uncomment the following if you want avrdude's erase cycle counter. +# Note that this counter needs to be initialized first using -Yn, +# see avrdude manual. +#AVRDUDE_ERASE_COUNTER = -y + +# Uncomment the following if you do /not/ wish a verification to be +# performed after programming the device. +AVRDUDE_NO_VERIFY = -V + +# Increase verbosity level. Please use this when submitting bug +# reports about avrdude. See +# to submit bug reports. +#AVRDUDE_VERBOSE = -v -v + +AVRDUDE_BASIC = -p $(MCU) -P $(AVRDUDE_PORT) -c $(AVRDUDE_PROGRAMMER) +AVRDUDE_FLAGS = $(AVRDUDE_BASIC) $(AVRDUDE_NO_VERIFY) $(AVRDUDE_VERBOSE) $(AVRDUDE_ERASE_COUNTER) + + +CC = avr-gcc +OBJCOPY = avr-objcopy +OBJDUMP = avr-objdump +SIZE = avr-size +NM = avr-nm +AVRDUDE = avrdude +REMOVE = rm -f +MV = mv -f + +# Define all object files. +OBJ = $(SRC:.c=.o) $(ASRC:.S=.o) + +# Define all listing files. +LST = $(ASRC:.S=.lst) $(SRC:.c=.lst) + +# Combine all necessary flags and optional flags. +# Add target processor to flags. +ALL_CFLAGS = -mmcu=$(MCU) -I. $(CFLAGS) +ALL_ASFLAGS = -mmcu=$(MCU) -I. -x assembler-with-cpp $(ASFLAGS) + + +# Default target. +all: build + +build: elf hex eep + +elf: $(TARGET).elf +hex: $(TARGET).hex +eep: $(TARGET).eep +lss: $(TARGET).lss +sym: $(TARGET).sym + + +# Program the device. +program: $(TARGET).hex $(TARGET).eep + $(AVRDUDE) $(AVRDUDE_FLAGS) $(AVRDUDE_WRITE_FLASH) $(AVRDUDE_WRITE_EEPROM) + + +size: + $(SIZE) -C --mcu=$(MCU) $(TARGET).elf + +# Convert ELF to COFF for use in debugging / simulating in AVR Studio or VMLAB. +COFFCONVERT=$(OBJCOPY) --debugging \ +--change-section-address .data-0x800000 \ +--change-section-address .bss-0x800000 \ +--change-section-address .noinit-0x800000 \ +--change-section-address .eeprom-0x810000 + + +coff: $(TARGET).elf + $(COFFCONVERT) -O coff-avr $(TARGET).elf $(TARGET).cof + + +extcoff: $(TARGET).elf + $(COFFCONVERT) -O coff-ext-avr $(TARGET).elf $(TARGET).cof + + +.SUFFIXES: .elf .hex .eep .lss .sym + +.elf.hex: + $(OBJCOPY) -O $(FORMAT) -R .eeprom $< $@ + +.elf.eep: + -$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \ + --change-section-lma .eeprom=0 -O $(FORMAT) $< $@ + +# Create extended listing file from ELF output file. +.elf.lss: + $(OBJDUMP) -h -S $< > $@ + +# Create a symbol table from ELF output file. +.elf.sym: + $(NM) -n $< > $@ + + + +# Link: create ELF output file from object files. +$(TARGET).elf: $(OBJ) + $(CC) $(ALL_CFLAGS) $(OBJ) --output $@ $(LDFLAGS) + + +# Compile: create object files from C source files. +.c.o: + $(CC) -c $(ALL_CFLAGS) $< -o $@ + + +# Compile: create assembler files from C source files. +.c.s: + $(CC) -S $(ALL_CFLAGS) $< -o $@ + + +# Assemble: create object files from assembler source files. +.S.o: + $(CC) -c $(ALL_ASFLAGS) $< -o $@ + + +# Target: clean project. +clean: + $(REMOVE) $(TARGET).hex $(TARGET).eep $(TARGET).cof $(TARGET).elf \ + $(TARGET).map $(TARGET).sym $(TARGET).lss \ + $(OBJ) $(LST) $(SRC:.c=.s) $(SRC:.c=.d) + +depend: + if grep '^# DO NOT DELETE' $(MAKEFILE) >/dev/null; \ + then \ + sed -e '/^# DO NOT DELETE/,$$d' $(MAKEFILE) > \ + $(MAKEFILE).$$$$ && \ + $(MV) $(MAKEFILE).$$$$ $(MAKEFILE); \ + fi + echo '# DO NOT DELETE THIS LINE -- make depend depends on it.' \ + >> $(MAKEFILE); \ + $(CC) -M -mmcu=$(MCU) $(CDEFS) $(CINCS) $(SRC) $(ASRC) >> $(MAKEFILE) + +.PHONY: all build elf hex eep lss sym program coff extcoff clean depend program_bootloader program_arduino + +program_bootloader: all + dfu-programmer $(MCU) erase && dfu-programmer $(MCU) flash $(TARGET).hex && dfu-programmer $(MCU) start + +program_arduino: all + avrdude -patmega32u4 -cavr109 -P$(PORT) -b57600 -D -Uflash:w:$(TARGET).hex:i diff --git a/atmega32u4/dcdc_rich/README.md b/atmega32u4/dcdc_rich/README.md new file mode 100644 index 0000000..cdc7231 --- /dev/null +++ b/atmega32u4/dcdc_rich/README.md @@ -0,0 +1,51 @@ +# RICH DCDC Converter board + +This is the firmeware of the RICH DCDC converter board. It serves as the power supply for one Backplane and converts 24V input voltage to the 4 voltages needed for the DiRICH. The voltages are adjustedable in a specific range. The minimum is selected for a 1.2 meter connection cable. + +______________________________________________________________________________________________________________ + +## Installation + +First, reset the microcontroller. + +``` bash +make clean && make NUMBER=55 && sudo dfu-programmer atmega32u4 erase --force && sudo make program_bootloader +``` + +Don't forget to change the Serial Number (here 55) to the correct value. + +Note the serial number on a sticker on the board and add it to a database. + +______________________________________________________________________________________________________________ + +## Register definition + +| Registers | description | +|-----------|-------------------------------------------- +| 0 | DCDC On/Off -> not available | +| 1 | DCDC set voltage adjustment resistors | +| 2 | Voltage V_in | +| 3 | Current C_in | +| 4 | Temperature | +| 5 | [15:2] Frimware; [1] Switch ; [0] LED | + +______________________________________________________________________________________________________________ + +## Protokoll definition + +**Data format:** *XuuGcRvvvv* + +The data format has to end with \n + +|Value | Description | +|------|-------------------------------------------------------------------------------| +|X | command (write: W, read: R, answer: A etc.) | +|uu | Controllernumber (Hex value) | +|G | Groupnumber (to talk to all channels, that belong together, in one command.) | +|c | channelnumber in the group (Hex value) | +|R | register (Hex value) | +|vvvv | 16 Bit value | + +All in all 10 characters + +close with a "\n", so a correct data fromat would be e.g. "RF2012FE51\n" diff --git a/atmega32u4/dcdc_rich/main.c b/atmega32u4/dcdc_rich/main.c new file mode 100644 index 0000000..6232261 --- /dev/null +++ b/atmega32u4/dcdc_rich/main.c @@ -0,0 +1,412 @@ +// #define F_CPU 8000000UL + +#include +#include +#include +#include +#include +#include + +#define FIRMWARE_VERSION 0x001 + + +#define LED_ON() PORTB |= (1<> (nib*4)) & 0xF; + if (t <= 9) {return t + 0x30;} + return t - 10 + 0x61; + } + +uint8_t hex_to_int(uint8_t h) { //assumes valid number + if (h < 0x40) return h-0x30; + if (h < 0x50) return h-0x41+10; + return h-0x61+10; + } + + +void sub1(uint8_t* c1, uint8_t* c2) { + uint8_t b = hex_to_int(*c1)*16 + hex_to_int(*c2); + b -= 1; + *c1 = nib_to_hex(b,1); + *c2 = nib_to_hex(b,0); + } + +void send_answer_buf(uint8_t* b) { + UCSR1B |= (1<< UDRIE1); + } + +void send_answer_hex(uint8_t* rxbuf, uint16_t v) { + txbuf[0]='A'; + txbuf[1]=rxbuf[1]; + txbuf[2]=rxbuf[2]; + txbuf[3]=rxbuf[3]; + txbuf[4]=rxbuf[4]; + txbuf[5]=rxbuf[5]; + txbuf[6]=nib_to_hex(v,3); + txbuf[7]=nib_to_hex(v,2); + txbuf[8]=nib_to_hex(v,1); + txbuf[9]=nib_to_hex(v,0); + txbuf[10]='\n'; + txbuf[11] = 0; + send_answer_buf(txbuf); + } + +void forward_msg(uint8_t i) { + sub1(&rxbuf[1],&rxbuf[2]); + memcpy ((uint8_t*)txbuf,(uint8_t*)rxbuf,i); + txbuf[i] = 0; + send_answer_buf(txbuf); + } + +uint8_t is_my_address(uint8_t s) { + if (ISMYADDR()) { + rxbuf[2] -= '0'; // write number to buffer, instead of ascii. + return 1; + } else { + forward_msg(s); + return 0; + } +} + +//NPIC6C596A +void setVoltages(void){ + cli(); + STCP_LOW(); + for (unsigned int i = 3; i >= 0; i-- ){ + for (unsigned int j = 0; j < 5; j++){// 5 times to fill also Q7S + SHCP_LOW(); + SHIFT_DATA_LOW(); + SHCP_HIGH(); // write + } + for (unsigned int j = 3; j >= 0; j--){ + SHCP_LOW(); + if (dcdc_settings[i][j] == 1) { + SHIFT_DATA_HIGH(); + } else { + SHIFT_DATA_LOW(); + } + SHCP_HIGH();// write + } + } + SHCP_LOW(); + SHIFT_DATA_LOW(); + //Load to Ouput Register: + STCP_HIGH(); + STCP_HIGH(); + STCP_LOW(); + STCP_LOW(); + + sei(); +} + + +void switchDCDC(uint8_t chan, uint8_t val) { + +} + +void setDCDC(uint8_t chan, uint8_t val) { + if (chan < 4){ + dcdc_settings[chan][0] = (val>>0) & 0x1; + dcdc_settings[chan][1] = (val>>1) & 0x1; + dcdc_settings[chan][2] = (val>>2) & 0x1; + dcdc_settings[chan][3] = (val>>3) & 0x1; + } + setVoltages(); +} + +void setInfo(uint8_t chan, uint8_t val){ + if ((val & 0x1) == 1) LED_ON(); // LED on + if ((val & 0x1) == 0) LED_OFF(); // LED off +} + +uint16_t conversion_ADC(uint8_t mode) { + uint8_t get_value_1; + uint8_t get_value_2; + uint8_t channel = 0; + uint8_t temp = 0b11101011; + if (mode == 0 ) { channel = 0; temp = 0b11101011;} // Current + if (mode == 1 ) { channel = 2; temp = 0b11101011;} // Voltage + if (mode == 2 ) { channel = 0; temp = 0b11111011;} // Temperature + SPDR = 0b11000011 + ((channel & 0b00000011) << 4); // MSB=Byte1 + while ((SPSR & (1< not avail. for <= Rev1_2 + * 1 | DCDC set voltage adjustment resistors + * 2 | Voltage V_in + * 3 | Current C_in + * 4 | Temperature + * 5 | [15:2] Frimware; [1] Switch ; [0] LED + ***/ + +void getdata(uint8_t buf) { + if (rxcnt != 0 || (buf == 'W' || buf == 'R' || buf == 'A' )) { + rxbuf[rxcnt++] = buf; + } + if (buf == '\n' || buf == '\r') { //End of Command + + if (rxbuf[0] == 'A') { + memcpy ((uint8_t*)txbuf,(uint8_t*)rxbuf,10); + txbuf[10] = 0; + send_answer_buf(txbuf); + } else if (is_my_address(10)){ // message is for this uC + + if (rxbuf[0] == 'W'){ //write + + // switch DCDC channel On/Off + if (hex_to_int(rxbuf[5]) == 0) { + switchDCDC(hex_to_int(rxbuf[4]),hex_to_int(rxbuf[9])); + } + + // set voltage of DCDC-Converter + if (hex_to_int(rxbuf[5]) == 1) { + setDCDC(hex_to_int(rxbuf[4]),hex_to_int(rxbuf[9])); + eeprom_update_byte((uint8_t*)(0x20+hex_to_int(rxbuf[4])),hex_to_int(rxbuf[9])&0xF); + } + + // switch DCDC channel On + if (hex_to_int(rxbuf[5]) == 5) { + setInfo(hex_to_int(rxbuf[4]),/* hex_to_int(rxbuf[6])*4096 + +hex_to_int(rxbuf[7])*256 + +hex_to_int(rxbuf[8])*16 + +*/hex_to_int(rxbuf[9])); + } + } + + if (rxbuf[0] == 'R'){ //read + + // get DCDC channel status + if (hex_to_int(rxbuf[5]) == 0) { + send_answer_hex(&rxbuf[0],1); + } + + // get DCDC selection + if (hex_to_int(rxbuf[5]) == 1) { + uint8_t setting = 0xFF; + if (hex_to_int(rxbuf[4]) < 4) setting = ((dcdc_settings[hex_to_int(rxbuf[4])][3]&0x1<<12) | + (dcdc_settings[hex_to_int(rxbuf[4])][2]&0x1<< 8) | + (dcdc_settings[hex_to_int(rxbuf[4])][1]&0x1<< 4) | + (dcdc_settings[hex_to_int(rxbuf[4])][0]&0x1) + ); + send_answer_hex(&rxbuf[0],setting); + } + + // get voltage V_in + if (hex_to_int(rxbuf[5]) == 2) { + send_answer_hex(&rxbuf[0],adc_volt); + } + + // get current C_in + if (hex_to_int(rxbuf[5]) == 3) { + send_answer_hex(&rxbuf[0],adc_curr); + } + + // get temperature + if (hex_to_int(rxbuf[5]) == 4) { + send_answer_hex(&rxbuf[0],adc_temp); + } + + // get temperature + if (hex_to_int(rxbuf[5]) == 5) { + uint16_t res = (FIRMWARE_VERSION<<4) & (0<<1) & (0<<0); + send_answer_hex(&rxbuf[0],res); + } + } + } + } + + + if (rxcnt >= 10 || buf == '\n' || buf == '\r') { rxcnt = 0; } + +} + + +ISR(USART1_RX_vect) { + uint8_t buf = UDR1; + getdata(buf); +} + +ISR(USART1_UDRE_vect) { + if(txbuf[txpoint] != 0) + UDR1 = txbuf[txpoint++]; + if(txpoint > 11 || txbuf[txpoint] == 0) { + txpoint = 0; + UCSR1B &= ~(1<< UDRIE1); //deactivate Transmit + } + } + +ISR(TIMER0_OVF_vect) { + time++; + asm volatile("wdr"); +} + +__attribute__((naked)) int main(void) { + + CLKPR = (1 << CLKPCE); // prescaler 2 = 8 MHz + CLKPR = (1 << CLKPS0); // prescaler 2 + //usb_init(); + +//Channels 0 1 2 3: PD4, PB6, PF6, PF1 +//Buttons 0 1 2 3: PD1, PD0, PB7, PB3 +//ADC ref: PF0(0,0) +//Sense 0 1 2 3: PD6(9,3+MUX5), PD7(10,4+MUX5), PF7(7,7), PF4(4,4) (channel, ADMUX value) +//LED 0: PE6 +//Select: PC6 + + // Configure ports + + MCUCR |= (1< 0: no PullUp 1: Pullup + // Output -> 0: LOW 1: HIGH + + PORTB = 0b00000110; //CB3|CB2|CB1|CB0|MISO|MOSI|SCL|~CS + DDRB = 0b00000111; + + PORTC = 0b10111111; // -|SEL|-|-|-|-|-|- + DDRC = 0b01000000; + + PORTD = 0b00001111; // CB1|CB3|CB0|CB2|TX|RX|-|- + DDRD = 0b11110000; + + PORTE = 0b11111111; // LED On; unconn. inputs are with internal PullUp + DDRE = 0b01000000; // -|LED|-|-|-|-|-|- + + PORTF = 0b10001111; // -|DAT|SHCP|STCP|-|-|~MS_RST|~OE + DDRF = 0b01110011; + + //Timer0 at 30 Hz overflow for ADC control + TCCR0B = (5 << CS00); + TIMSK0 = (1 << TOIE0); //Overflow interrupt` + + + //Init USART + UCSR1A = (1 << U2X1); // Double Speed Mode + UCSR1B = (1 << RXCIE1) | (0 << TXCIE1) | (0 << RXEN1) | (1 << TXEN1); + UCSR1C = (3 << UCSZ10); //8 Bit + UBRR1 = 0x10; //57600 + _delay_ms(10); + UCSR1B |= (1 << RXEN1); + + //SPI INIT + SPCR = (1<> 0)& 0x1; + dcdc_settings[0][1] = (eeprom_value >> 1)& 0x1; + dcdc_settings[0][2] = (eeprom_value >> 2)& 0x1; + dcdc_settings[0][3] = (eeprom_value >> 3)& 0x1; + + eeprom_value = eeprom_read_byte((uint8_t*)0x21); + dcdc_settings[1][0] = (eeprom_value >> 0)& 0x1; + dcdc_settings[1][1] = (eeprom_value >> 1)& 0x1; + dcdc_settings[1][2] = (eeprom_value >> 2)& 0x1; + dcdc_settings[1][3] = (eeprom_value >> 3)& 0x1; + + eeprom_value = eeprom_read_byte((uint8_t*)0x22); + dcdc_settings[2][0] = (eeprom_value >> 0)& 0x1; + dcdc_settings[2][1] = (eeprom_value >> 1)& 0x1; + dcdc_settings[2][2] = (eeprom_value >> 2)& 0x1; + dcdc_settings[2][3] = (eeprom_value >> 3)& 0x1; + + eeprom_value = eeprom_read_byte((uint8_t*)0x23); + dcdc_settings[3][0] = (eeprom_value >> 0)& 0x1; + dcdc_settings[3][1] = (eeprom_value >> 1)& 0x1; + dcdc_settings[3][2] = (eeprom_value >> 2)& 0x1; + dcdc_settings[3][3] = (eeprom_value >> 3)& 0x1; + + setVoltages(); + SHIFT_EN_OUTPUT(); // Enable output of shift register to mosfet + sei(); + uint8_t ADC_State = 0; // 0: start of uC; 1: Volt; 2: Current; 3: Temp + uint16_t lasttime = 0; + while(1) { + + if((time != lasttime) && ((time %10) == 0)) { + //~330us for each conversion + if (ADC_State == 3) {adc_temp = read_ADC(); ADC_State = 0;} + if (ADC_State == 2) {adc_volt = read_ADC(); ADC_State = 3;} + if (ADC_State == 1) {adc_curr = read_ADC(); ADC_State = 2;} + if (ADC_State == 0) ADC_State = 1; + + conversion_ADC(ADC_State - 1); + } + + lasttime = time; + } +} diff --git a/atmega32u4/dcdc_rich/usb_serial.c b/atmega32u4/dcdc_rich/usb_serial.c new file mode 100644 index 0000000..16d7723 --- /dev/null +++ b/atmega32u4/dcdc_rich/usb_serial.c @@ -0,0 +1,937 @@ +/* USB Serial Example for Teensy USB Development Board + * http://www.pjrc.com/teensy/usb_serial.html + * Copyright (c) 2008,2010,2011 PJRC.COM, LLC + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + */ + +// Version 1.0: Initial Release +// Version 1.1: support Teensy++ +// Version 1.2: fixed usb_serial_available +// Version 1.3: added transmit bandwidth test +// Version 1.4: added usb_serial_write +// Version 1.5: add support for Teensy 2.0 +// Version 1.6: fix zero length packet bug +// Version 1.7: fix usb_serial_set_control + +#define USB_SERIAL_PRIVATE_INCLUDE +#include "usb_serial.h" + + +/************************************************************************** + * + * Configurable Options + * + **************************************************************************/ + +// You can change these to give your code its own name. On Windows, +// these are only used before an INF file (driver install) is loaded. +#define STR_MANUFACTURER L"TRB3" +#define STR_PRODUCT L"Power48" + +// All USB serial devices are supposed to have a serial number +// (according to Microsoft). On windows, a new COM port is created +// for every unique serial/vendor/product number combination. If +// you program 2 identical boards with 2 different serial numbers +// and they are assigned COM7 and COM8, each will always get the +// same COM port number because Windows remembers serial numbers. +// +// On Mac OS-X, a device file is created automatically which +// incorperates the serial number, eg, /dev/cu-usbmodem12341 +// +// Linux by default ignores the serial number, and creates device +// files named /dev/ttyACM0, /dev/ttyACM1... in the order connected. +// Udev rules (in /etc/udev/rules.d) can define persistent device +// names linked to this serial number, as well as permissions, owner +// and group settings. +//#define STR_SERIAL_NUMBER L ## NUMBER + + +// Mac OS-X and Linux automatically load the correct drivers. On +// Windows, even though the driver is supplied by Microsoft, an +// INF file is needed to load the driver. These numbers need to +// match the INF file. +#define VENDOR_ID 0x16C0 +#define PRODUCT_ID 0x047A + +// When you write data, it goes into a USB endpoint buffer, which +// is transmitted to the PC when it becomes full, or after a timeout +// with no more writes. Even if you write in exactly packet-size +// increments, this timeout is used to send a "zero length packet" +// that tells the PC no more data is expected and it should pass +// any buffered data to the application that may be waiting. If +// you want data sent immediately, call usb_serial_flush_output(). +#define TRANSMIT_FLUSH_TIMEOUT 5 /* in milliseconds */ + +// If the PC is connected but not "listening", this is the length +// of time before usb_serial_getchar() returns with an error. This +// is roughly equivilant to a real UART simply transmitting the +// bits on a wire where nobody is listening, except you get an error +// code which you can ignore for serial-like discard of data, or +// use to know your data wasn't sent. +#define TRANSMIT_TIMEOUT 25 /* in milliseconds */ + +// USB devices are supposed to implment a halt feature, which is +// rarely (if ever) used. If you comment this line out, the halt +// code will be removed, saving 116 bytes of space (gcc 4.3.0). +// This is not strictly USB compliant, but works with all major +// operating systems. +//#define SUPPORT_ENDPOINT_HALT + + + +/************************************************************************** + * + * Endpoint Buffer Configuration + * + **************************************************************************/ + +// These buffer sizes are best for most applications, but perhaps if you +// want more buffering on some endpoint at the expense of others, this +// is where you can make such changes. The AT90USB162 has only 176 bytes +// of DPRAM (USB buffers) and only endpoints 3 & 4 can double buffer. + +#define ENDPOINT0_SIZE 16 +#define CDC_ACM_ENDPOINT 2 +#define CDC_RX_ENDPOINT 3 +#define CDC_TX_ENDPOINT 4 +#if defined(__AVR_AT90USB162__) +#define CDC_ACM_SIZE 16 +#define CDC_ACM_BUFFER EP_SINGLE_BUFFER +#define CDC_RX_SIZE 32 +#define CDC_RX_BUFFER EP_DOUBLE_BUFFER +#define CDC_TX_SIZE 32 +#define CDC_TX_BUFFER EP_DOUBLE_BUFFER +#else +#define CDC_ACM_SIZE 16 +#define CDC_ACM_BUFFER EP_SINGLE_BUFFER +#define CDC_RX_SIZE 64 +#define CDC_RX_BUFFER EP_DOUBLE_BUFFER +#define CDC_TX_SIZE 64 +#define CDC_TX_BUFFER EP_DOUBLE_BUFFER +#endif + +static const uint8_t PROGMEM endpoint_config_table[] = { + 0, + 1, EP_TYPE_INTERRUPT_IN, EP_SIZE(CDC_ACM_SIZE) | CDC_ACM_BUFFER, + 1, EP_TYPE_BULK_OUT, EP_SIZE(CDC_RX_SIZE) | CDC_RX_BUFFER, + 1, EP_TYPE_BULK_IN, EP_SIZE(CDC_TX_SIZE) | CDC_TX_BUFFER +}; + + +/************************************************************************** + * + * Descriptor Data + * + **************************************************************************/ + +// Descriptors are the data that your computer reads when it auto-detects +// this USB device (called "enumeration" in USB lingo). The most commonly +// changed items are editable at the top of this file. Changing things +// in here should only be done by those who've read chapter 9 of the USB +// spec and relevant portions of any USB class specifications! + +static const uint8_t PROGMEM device_descriptor[] = { + 18, // bLength + 1, // bDescriptorType + 0x00, 0x02, // bcdUSB + 2, // bDeviceClass + 0, // bDeviceSubClass + 0, // bDeviceProtocol + ENDPOINT0_SIZE, // bMaxPacketSize0 + LSB(VENDOR_ID), MSB(VENDOR_ID), // idVendor + LSB(PRODUCT_ID), MSB(PRODUCT_ID), // idProduct + 0x00, 0x01, // bcdDevice + 1, // iManufacturer + 2, // iProduct + 3, // iSerialNumber + 1 // bNumConfigurations +}; + +#define CONFIG1_DESC_SIZE (9+9+5+5+4+5+7+9+7+7) +static const uint8_t PROGMEM config1_descriptor[CONFIG1_DESC_SIZE] = { + // configuration descriptor, USB spec 9.6.3, page 264-266, Table 9-10 + 9, // bLength; + 2, // bDescriptorType; + LSB(CONFIG1_DESC_SIZE), // wTotalLength + MSB(CONFIG1_DESC_SIZE), + 2, // bNumInterfaces + 1, // bConfigurationValue + 0, // iConfiguration + 0xC0, // bmAttributes + 50, // bMaxPower + // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12 + 9, // bLength + 4, // bDescriptorType + 0, // bInterfaceNumber + 0, // bAlternateSetting + 1, // bNumEndpoints + 0x02, // bInterfaceClass + 0x02, // bInterfaceSubClass + 0x01, // bInterfaceProtocol + 0, // iInterface + // CDC Header Functional Descriptor, CDC Spec 5.2.3.1, Table 26 + 5, // bFunctionLength + 0x24, // bDescriptorType + 0x00, // bDescriptorSubtype + 0x10, 0x01, // bcdCDC + // Call Management Functional Descriptor, CDC Spec 5.2.3.2, Table 27 + 5, // bFunctionLength + 0x24, // bDescriptorType + 0x01, // bDescriptorSubtype + 0x01, // bmCapabilities + 1, // bDataInterface + // Abstract Control Management Functional Descriptor, CDC Spec 5.2.3.3, Table 28 + 4, // bFunctionLength + 0x24, // bDescriptorType + 0x02, // bDescriptorSubtype + 0x06, // bmCapabilities + // Union Functional Descriptor, CDC Spec 5.2.3.8, Table 33 + 5, // bFunctionLength + 0x24, // bDescriptorType + 0x06, // bDescriptorSubtype + 0, // bMasterInterface + 1, // bSlaveInterface0 + // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13 + 7, // bLength + 5, // bDescriptorType + CDC_ACM_ENDPOINT | 0x80, // bEndpointAddress + 0x03, // bmAttributes (0x03=intr) + CDC_ACM_SIZE, 0, // wMaxPacketSize + 64, // bInterval + // interface descriptor, USB spec 9.6.5, page 267-269, Table 9-12 + 9, // bLength + 4, // bDescriptorType + 1, // bInterfaceNumber + 0, // bAlternateSetting + 2, // bNumEndpoints + 0x0A, // bInterfaceClass + 0x00, // bInterfaceSubClass + 0x00, // bInterfaceProtocol + 0, // iInterface + // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13 + 7, // bLength + 5, // bDescriptorType + CDC_RX_ENDPOINT, // bEndpointAddress + 0x02, // bmAttributes (0x02=bulk) + CDC_RX_SIZE, 0, // wMaxPacketSize + 0, // bInterval + // endpoint descriptor, USB spec 9.6.6, page 269-271, Table 9-13 + 7, // bLength + 5, // bDescriptorType + CDC_TX_ENDPOINT | 0x80, // bEndpointAddress + 0x02, // bmAttributes (0x02=bulk) + CDC_TX_SIZE, 0, // wMaxPacketSize + 0 // bInterval +}; + +// If you're desperate for a little extra code memory, these strings +// can be completely removed if iManufacturer, iProduct, iSerialNumber +// in the device desciptor are changed to zeros. +struct usb_string_descriptor_struct { + uint8_t bLength; + uint8_t bDescriptorType; + int16_t wString[]; +}; +static const struct usb_string_descriptor_struct PROGMEM string0 = { + 4, + 3, + {0x0409} +}; +static const struct usb_string_descriptor_struct PROGMEM string1 = { + sizeof(STR_MANUFACTURER), + 3, + STR_MANUFACTURER +}; +static const struct usb_string_descriptor_struct PROGMEM string2 = { + sizeof(STR_PRODUCT), + 3, + STR_PRODUCT +}; +static const struct usb_string_descriptor_struct PROGMEM string3 = { + sizeof(STR_SERIAL_NUMBER), + 3, + STR_SERIAL_NUMBER +}; + +// This table defines which descriptor data is sent for each specific +// request from the host (in wValue and wIndex). +static const struct descriptor_list_struct { + uint16_t wValue; + uint16_t wIndex; + const uint8_t *addr; + uint8_t length; +} PROGMEM descriptor_list[] = { + {0x0100, 0x0000, device_descriptor, sizeof(device_descriptor)}, + {0x0200, 0x0000, config1_descriptor, sizeof(config1_descriptor)}, + {0x0300, 0x0000, (const uint8_t *)&string0, 4}, + {0x0301, 0x0409, (const uint8_t *)&string1, sizeof(STR_MANUFACTURER)}, + {0x0302, 0x0409, (const uint8_t *)&string2, sizeof(STR_PRODUCT)}, + {0x0303, 0x0409, (const uint8_t *)&string3, sizeof(STR_SERIAL_NUMBER)} +}; +#define NUM_DESC_LIST (sizeof(descriptor_list)/sizeof(struct descriptor_list_struct)) + + +/************************************************************************** + * + * Variables - these are the only non-stack RAM usage + * + **************************************************************************/ + +// zero when we are not configured, non-zero when enumerated +static volatile uint8_t usb_configuration=0; + +// the time remaining before we transmit any partially full +// packet, or send a zero length packet. +static volatile uint8_t transmit_flush_timer=0; +static uint8_t transmit_previous_timeout=0; + +// serial port settings (baud rate, control signals, etc) set +// by the PC. These are ignored, but kept in RAM. +static uint8_t cdc_line_coding[7]={0x00, 0xE1, 0x00, 0x00, 0x00, 0x00, 0x08}; +static uint8_t cdc_line_rtsdtr=0; + + +/************************************************************************** + * + * Public Functions - these are the API intended for the user + * + **************************************************************************/ + +// initialize USB serial +void usb_init(void) +{ + HW_CONFIG(); + USB_FREEZE(); // enable USB + PLL_CONFIG(); // config PLL, 16 MHz xtal + while (!(PLLCSR & (1< size) write_size = size; + size -= write_size; + + // write the packet + switch (write_size) { + #if (CDC_TX_SIZE == 64) + case 64: UEDATX = *buffer++; + case 63: UEDATX = *buffer++; + case 62: UEDATX = *buffer++; + case 61: UEDATX = *buffer++; + case 60: UEDATX = *buffer++; + case 59: UEDATX = *buffer++; + case 58: UEDATX = *buffer++; + case 57: UEDATX = *buffer++; + case 56: UEDATX = *buffer++; + case 55: UEDATX = *buffer++; + case 54: UEDATX = *buffer++; + case 53: UEDATX = *buffer++; + case 52: UEDATX = *buffer++; + case 51: UEDATX = *buffer++; + case 50: UEDATX = *buffer++; + case 49: UEDATX = *buffer++; + case 48: UEDATX = *buffer++; + case 47: UEDATX = *buffer++; + case 46: UEDATX = *buffer++; + case 45: UEDATX = *buffer++; + case 44: UEDATX = *buffer++; + case 43: UEDATX = *buffer++; + case 42: UEDATX = *buffer++; + case 41: UEDATX = *buffer++; + case 40: UEDATX = *buffer++; + case 39: UEDATX = *buffer++; + case 38: UEDATX = *buffer++; + case 37: UEDATX = *buffer++; + case 36: UEDATX = *buffer++; + case 35: UEDATX = *buffer++; + case 34: UEDATX = *buffer++; + case 33: UEDATX = *buffer++; + #endif + #if (CDC_TX_SIZE >= 32) + case 32: UEDATX = *buffer++; + case 31: UEDATX = *buffer++; + case 30: UEDATX = *buffer++; + case 29: UEDATX = *buffer++; + case 28: UEDATX = *buffer++; + case 27: UEDATX = *buffer++; + case 26: UEDATX = *buffer++; + case 25: UEDATX = *buffer++; + case 24: UEDATX = *buffer++; + case 23: UEDATX = *buffer++; + case 22: UEDATX = *buffer++; + case 21: UEDATX = *buffer++; + case 20: UEDATX = *buffer++; + case 19: UEDATX = *buffer++; + case 18: UEDATX = *buffer++; + case 17: UEDATX = *buffer++; + #endif + #if (CDC_TX_SIZE >= 16) + case 16: UEDATX = *buffer++; + case 15: UEDATX = *buffer++; + case 14: UEDATX = *buffer++; + case 13: UEDATX = *buffer++; + case 12: UEDATX = *buffer++; + case 11: UEDATX = *buffer++; + case 10: UEDATX = *buffer++; + case 9: UEDATX = *buffer++; + #endif + case 8: UEDATX = *buffer++; + case 7: UEDATX = *buffer++; + case 6: UEDATX = *buffer++; + case 5: UEDATX = *buffer++; + case 4: UEDATX = *buffer++; + case 3: UEDATX = *buffer++; + case 2: UEDATX = *buffer++; + default: + case 1: UEDATX = *buffer++; + case 0: break; + } + // if this completed a packet, transmit it now! + if (!(UEINTX & (1<= NUM_DESC_LIST) { + UECONX = (1< desc_length) len = desc_length; + do { + // wait for host ready for IN packet + do { + i = UEINTX; + } while (!(i & ((1<= 1 && i <= MAX_ENDPOINT) { + usb_send_in(); + UENUM = i; + if (bRequest == SET_FEATURE) { + UECONX = (1< + +// setup +void usb_init(void); // initialize everything +uint8_t usb_configured(void); // is the USB port configured + +// receiving data +int16_t usb_serial_getchar(void); // receive a character (-1 if timeout/error) +uint8_t usb_serial_available(void); // number of bytes in receive buffer +void usb_serial_flush_input(void); // discard any buffered input + +// transmitting data +int8_t usb_serial_putchar(uint8_t c); // transmit a character +int8_t usb_serial_putchar_nowait(uint8_t c); // transmit a character, do not wait +int8_t usb_serial_write(const uint8_t *buffer, uint16_t size); // transmit a buffer +void usb_serial_flush_output(void); // immediately transmit any buffered output + +// serial parameters +uint32_t usb_serial_get_baud(void); // get the baud rate +uint8_t usb_serial_get_stopbits(void); // get the number of stop bits +uint8_t usb_serial_get_paritytype(void);// get the parity type +uint8_t usb_serial_get_numbits(void); // get the number of data bits +uint8_t usb_serial_get_control(void); // get the RTS and DTR signal state +int8_t usb_serial_set_control(uint8_t signals); // set DSR, DCD, RI, etc + +// constants corresponding to the various serial parameters +#define USB_SERIAL_DTR 0x01 +#define USB_SERIAL_RTS 0x02 +#define USB_SERIAL_1_STOP 0 +#define USB_SERIAL_1_5_STOP 1 +#define USB_SERIAL_2_STOP 2 +#define USB_SERIAL_PARITY_NONE 0 +#define USB_SERIAL_PARITY_ODD 1 +#define USB_SERIAL_PARITY_EVEN 2 +#define USB_SERIAL_PARITY_MARK 3 +#define USB_SERIAL_PARITY_SPACE 4 +#define USB_SERIAL_DCD 0x01 +#define USB_SERIAL_DSR 0x02 +#define USB_SERIAL_BREAK 0x04 +#define USB_SERIAL_RI 0x08 +#define USB_SERIAL_FRAME_ERR 0x10 +#define USB_SERIAL_PARITY_ERR 0x20 +#define USB_SERIAL_OVERRUN_ERR 0x40 + +// This file does not include the HID debug functions, so these empty +// macros replace them with nothing, so users can compile code that +// has calls to these functions. +#define usb_debug_putchar(c) +#define usb_debug_flush_output() + + + +// Everything below this point is only intended for usb_serial.c +#ifdef USB_SERIAL_PRIVATE_INCLUDE +#include +#include +#include + +#define EP_TYPE_CONTROL 0x00 +#define EP_TYPE_BULK_IN 0x81 +#define EP_TYPE_BULK_OUT 0x80 +#define EP_TYPE_INTERRUPT_IN 0xC1 +#define EP_TYPE_INTERRUPT_OUT 0xC0 +#define EP_TYPE_ISOCHRONOUS_IN 0x41 +#define EP_TYPE_ISOCHRONOUS_OUT 0x40 +#define EP_SINGLE_BUFFER 0x02 +#define EP_DOUBLE_BUFFER 0x06 +#define EP_SIZE(s) ((s) == 64 ? 0x30 : \ + ((s) == 32 ? 0x20 : \ + ((s) == 16 ? 0x10 : \ + 0x00))) + +#define MAX_ENDPOINT 4 + +#define LSB(n) (n & 255) +#define MSB(n) ((n >> 8) & 255) + +#if defined(__AVR_AT90USB162__) +#define HW_CONFIG() +#define PLL_CONFIG() (PLLCSR = ((1<