diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b4fb6b4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# ---> VisualStudioCode +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +*.code-workspace + diff --git a/README.md b/README.md index 1fc8633..64f0d25 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,18 @@ # beeon +## Overview +The classic device was created several years ago to fill a single need, preventing my work computer from auto locking due to inactivity. *Subverting security policy comes with a responsibility to ensure that you lock your computer (CTRL+ALT+DEL) everytime you walk away!* + +## classic notes +### flash bootloader to board +`avrdude -c USBasp -p attiny85 -U flash:w:beeon-classic-v1-micronucleus-2.04.hex:i -B 10` +`avrdude -c USBasp -p attiny85 -U lfuse:w:0xe1:m -U hfuse:w:0xdd:m -U efuse:w:0xfe:m` +### upload new firmware onto board +`micronucleus --run {firmware.hex}` +### clear out any existing firmware +`micronucleus --erase-only` +### upload firmware with random serial number +*first create random serial number file* +`beeon-classic-sn -mk -mk-p=Z-ZZ > beeon-sn.txt` +`beeon-classic-sn | micronucleus --run -` + diff --git a/app/Makefile b/app/Makefile new file mode 100644 index 0000000..cfc790f --- /dev/null +++ b/app/Makefile @@ -0,0 +1,53 @@ +## +## +## + +.PHONY: help all linux darwin windows cli + +help: ## This help. + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +.DEFAULT_GOAL := all + +bin/: + @mkdir -p bin + +all: ## build linux, darwin & windows +all: linux darwin windows + +cli: linux-cli windows-cli darwin-cli + +linux: linux-cli +windows: windows-cli +darwin: darwin-cli + +linux-cli: bin/ ## build linux binary + @GOOS=linux GOARCH=amd64 CGO_ENABLED=1 \ + go build \ + -installsuffix cgo -ldflags=" -s -w" \ + -o bin/beeon-cli-linux-amd64 \ + microjelly.com/beeon/app/cmd/cli + +darwin-cli: bin/ ## build darwin binary + @GOOS=darwin GOARCH=amd64 CGO_ENABLED=1 \ + CC=o64-clang CXX=o64-clang++ \ + LDFLAGS="-linkmode external -s" \ + go build \ + -installsuffix cgo -ldflags=" -s -w" \ + -o bin/beeon-cli-darwin-amd64 \ + microjelly.com/beeon/app/cmd/cli + +windows-cli: bin/ ## build windows binary + @GOOS=windows GOARCH=amd64 CGO_ENABLED=1 \ + CC=x86_64-w64-mingw32-gcc \ + go build \ + -installsuffix cgo -ldflags=" -s -w" \ + -o bin/beeon-cli-windows-amd64.exe \ + microjelly.com/beeon/app/cmd/cli + +mod-tidy: + @go clean --modcache + @GOPROXY=direct GOSUMDB=off go mod tidy + +clean: + @rm -rf bin \ No newline at end of file diff --git a/app/build/.gitignore b/app/build/.gitignore new file mode 100644 index 0000000..1a6fd01 --- /dev/null +++ b/app/build/.gitignore @@ -0,0 +1,3 @@ +Dockerfile.dapper[0-9]* +.dapper +bin/ \ No newline at end of file diff --git a/app/build/Dockerfile.dapper b/app/build/Dockerfile.dapper new file mode 100644 index 0000000..93081c4 --- /dev/null +++ b/app/build/Dockerfile.dapper @@ -0,0 +1,10 @@ +FROM dockercore/golang-cross:latest +RUN apt-get update -qq \ + && apt-get install -y -q --no-install-recommends libusb-1.0-0-dev + +ENV DAPPER_SOURCE /source +ENV DAPPER_OUTPUT ./build/bin +WORKDIR ${DAPPER_SOURCE} + +ENTRYPOINT ["./build/scripts/entry"] +CMD ["cli"] \ No newline at end of file diff --git a/app/build/Makefile b/app/build/Makefile new file mode 100644 index 0000000..85510a0 --- /dev/null +++ b/app/build/Makefile @@ -0,0 +1,22 @@ +TARGETS := $(shell ls scripts) + +.dapper: + @echo Downloading dapper + @curl -sL https://releases.rancher.com/dapper/latest/dapper-`uname -s`-`uname -m` > .dapper.tmp + @@chmod +x .dapper.tmp + @./.dapper.tmp -v + @mv .dapper.tmp .dapper + +$(TARGETS): .dapper + cd ../ && $(PWD)/.dapper -f build/Dockerfile.dapper $@ + @yes | docker image prune > /dev/null + +.PHONY: $(TARGETS) +.DEFAULT_GOAL := cli + +clean: + @rm -rf $(PWD)/bin $(PWD)/.dapper $(PWD)/Dockerfile.dapper[0-9]* + @docker rmi app:master + +shell-bind: .dapper + cd ../ && $(PWD)/.dapper -f build/Dockerfile.dapper -m bind -s \ No newline at end of file diff --git a/app/build/scripts/cli b/app/build/scripts/cli new file mode 100755 index 0000000..7986f7c --- /dev/null +++ b/app/build/scripts/cli @@ -0,0 +1,7 @@ +#!/bin/bash +set -e + +## multi-platform cli build +make cli +cp bin/*cli* ${DAPPER_OUTPUT}/ +ls -la ${DAPPER_OUTPUT}/*cli* diff --git a/app/build/scripts/entry b/app/build/scripts/entry new file mode 100755 index 0000000..8c92812 --- /dev/null +++ b/app/build/scripts/entry @@ -0,0 +1,13 @@ +#!/bin/bash +set -e + +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" + +mkdir -p ${DAPPER_OUTPUT} +if [ -e ${DIR}/$1 ]; then + ${DIR}/"$@" +else + exec "$@" +fi + +chown -R $DAPPER_UID:$DAPPER_GID ${DAPPER_OUTPUT} \ No newline at end of file diff --git a/app/cmd/cli/cli.go b/app/cmd/cli/cli.go new file mode 100644 index 0000000..2a92b6c --- /dev/null +++ b/app/cmd/cli/cli.go @@ -0,0 +1,208 @@ +package main + +import ( + "flag" + "fmt" + "log" + "os" + "strings" + + "microjelly.com/beeon/app/pkg/device" + "microjelly.com/beeon/app/pkg/device/keycodes" + "microjelly.com/beeon/app/pkg/device/report3" +) + +var ( + appVersion string = "1.01" + vendorID uint16 = 0x16d0 + productID uint16 = 0x09fa +) + +func main() { + + var ( + action string = "none" + serialNumber string = "" + inState string = "" + newState report3.State = report3.StateUnset + inRate string = "" + newRate report3.Rate = report3.RateUnset + newMode report3.Mode = report3.ModeUnset + inMouseMode string = "" + newMouseMode report3.MouseMode = report3.MouseModeUnset + inKeyCode uint = 256 + newKeyCode keycodes.KeyCode = keycodes.KeyUnset + ) + + debugFlag := flag.Bool("debug", false, "enable debug logging") + listFlag := flag.Bool("list", false, "list connected devices") + readFlag := flag.Bool("read", false, "read device config") + flag.StringVar(&serialNumber, "serial", "", "target specific device by serial_number") + flag.StringVar(&inState, "state", "", "change device state ") + flag.StringVar(&inRate, "rate", "", "change device rate ") + flag.StringVar(&inMouseMode, "mouse", "", "change to mouse mode and set mode ") + flag.UintVar(&inKeyCode, "keyboard", 256, "change to keyboard mode and set keycod") + flag.Parse() + + if *debugFlag { + device.SetLogLevel(device.LogDebug) + } + + if *listFlag { + action = "list" + } else if *readFlag { + action = "read" + } + + log.Printf("beeon-cli core:%s usb:%t", device.Version(), device.UsbSupported()) + + if serialNumber != "" { + log.Printf("serial:%s", serialNumber) + } + + if action == "list" { + devs, err := device.Enumerate(vendorID, productID) + if err != nil { + panic(err) + } + for i, _dev := range devs { + log.Printf("[%d] %s:v%s:%s:%s", + i, + _dev.Serial, + fmt.Sprintf("%d.%02d", (_dev.Version&0xff00)>>8, (_dev.Version&0x00ff)), + _dev.Manufacturer, + _dev.Product, + ) + } + os.Exit(0) + } + + if action == "read" { + r3, err := device.ReadReport3(vendorID, productID, serialNumber) + if err != nil { + log.Printf(err.Error()) + os.Exit(1) + } + log.Printf("%+v", r3) + } + + if inMouseMode != "" { + switch strings.ToLower(inMouseMode) { + case "circle": + newMouseMode = report3.MouseModeCircle + newMode = report3.ModeMouse + action = "write" + case "random": + newMouseMode = report3.MouseModeRandom + newMode = report3.ModeMouse + action = "write" + default: + log.Printf("invalid mouse-mode %s", inMouseMode) + } + } + + if inKeyCode != 256 && action == "none" { + newKeyCode = keycodes.KeyCode(inKeyCode) + newMode = report3.ModeKeyboard + action = "write" + } + + if inState != "" { + switch strings.ToLower(inState) { + case "idle": + newState = report3.StateIdle + action = "write" + case "active": + newState = report3.StateActive + action = "write" + default: + log.Printf("invalid state %s", inState) + } + } + + if inRate != "" { + switch strings.ToLower(inRate) { + case "extra-slow": + newRate = report3.RateExtraSlow + action = "write" + case "slow": + newRate = report3.RateSlow + action = "write" + case "normal": + newRate = report3.RateNormal + action = "write" + case "fast": + newRate = report3.RateFast + action = "write" + default: + log.Printf("invalid rate %s", inRate) + } + } + + if action == "none" { + flag.PrintDefaults() + os.Exit(1) + } + + if action == "write" { + hasChange := false + whatChanged := []string{} + r3, err := device.ReadReport3(vendorID, productID, serialNumber) + if err != nil { + log.Printf(err.Error()) + os.Exit(1) + } + + if (newMode != report3.ModeUnset) && (r3.Mode != newMode) { + whatChanged = append(whatChanged, fmt.Sprintf("Mode(%s>%s)", r3.Mode, newMode)) + r3.Mode = newMode + hasChange = true + } else { + r3.Mode = report3.ModeUnset + } + + if newKeyCode != keycodes.KeyUnset && (newKeyCode != r3.KeyCode) { + whatChanged = append(whatChanged, fmt.Sprintf("KeyCode(%s>%s)", r3.KeyCode, newKeyCode)) + r3.KeyCode = newKeyCode + hasChange = true + } else { + r3.KeyCode = keycodes.KeyUnset + } + + if newMouseMode != report3.MouseModeUnset && (newMouseMode != r3.MouseMode) { + whatChanged = append(whatChanged, fmt.Sprintf("MouseMode(%s>%s)", r3.MouseMode, newMouseMode)) + r3.MouseMode = newMouseMode + hasChange = true + } else { + r3.MouseMode = report3.MouseModeUnset + } + + if newState != report3.StateUnset && (newState != r3.State) { + whatChanged = append(whatChanged, fmt.Sprintf("State(%s>%s)", r3.State, newState)) + r3.State = newState + hasChange = true + } else { + r3.State = report3.StateUnset + } + + if newRate != report3.RateUnset && (newRate != r3.Rate) { + whatChanged = append(whatChanged, fmt.Sprintf("Rate(%s>%s)", r3.Rate, newRate)) + r3.Rate = newRate + hasChange = true + } else { + r3.Rate = report3.RateUnset + } + + if hasChange { + err := device.WriteReport3(vendorID, productID, serialNumber, r3.Bytes()) + if err != nil { + log.Printf(err.Error()) + os.Exit(1) + } + log.Printf("changes made {%s}", strings.Join(whatChanged, "; ")) + } else { + log.Printf("no changes") + } + } + +} diff --git a/app/go.mod b/app/go.mod new file mode 100644 index 0000000..9fbbc13 --- /dev/null +++ b/app/go.mod @@ -0,0 +1,5 @@ +module microjelly.com/beeon/app + +go 1.13 + +require github.com/microjelly/hid v0.0.0-20200814141453-3602713b3885 diff --git a/app/go.sum b/app/go.sum new file mode 100644 index 0000000..0336e84 --- /dev/null +++ b/app/go.sum @@ -0,0 +1,2 @@ +github.com/microjelly/hid v0.0.0-20200814141453-3602713b3885 h1:UdpWecEd/pxs7YgX+gYnROdB4ID6oKIuv2GnVhhXofk= +github.com/microjelly/hid v0.0.0-20200814141453-3602713b3885/go.mod h1:bPSrfoMz72p90YvMJSC/hCd0xL7MebXTyM8oWhtsgu8= diff --git a/app/pkg/device/device.go b/app/pkg/device/device.go new file mode 100644 index 0000000..88ee5df --- /dev/null +++ b/app/pkg/device/device.go @@ -0,0 +1,106 @@ +package device + +import ( + "errors" + "log" + + "github.com/microjelly/hid" + "microjelly.com/beeon/app/pkg/device/report3" +) + +var ( + _devices []Info + _logLevel LogLevel = LogNone +) + +// Version - returns the version of this module +func Version() string { + return "v1.0.1" +} + +// UsbSupported - returns true if usb is supported on this platform +func UsbSupported() bool { + return hid.Supported() +} + +// SetLogLevel - sets the logging level +func SetLogLevel(level LogLevel) { + _logLevel = level +} + +// Enumerate - gets connected devices +func Enumerate(vendorID uint16, productID uint16) ([]Info, error) { + + var ( + _devices []Info = nil + pSN string = "" + ) + + for _, dev := range hid.Enumerate(vendorID, productID) { + if dev.Serial != pSN { + _devices = append(_devices, Info{ + Serial: dev.Serial, + Version: dev.Release, + Manufacturer: dev.Manufacturer, + Product: dev.Product, + }) + pSN = dev.Serial + } + } + + return _devices, nil +} + +func open(vendorID uint16, productID uint16, serial string) (*hid.Device, error) { + + devices := hid.Enumerate(vendorID, productID) + for _, dev := range devices { + if (serial != "" && dev.Serial == serial) || serial == "" { + _log(LogInfo, "opening device [%s]", dev.Serial) + return dev.Open() + } + } + return nil, errors.New("device not found") +} + +// ReadReport3 - get device configuration +func ReadReport3(vendorID uint16, productID uint16, serial string) (*report3.Report, error) { + + report := []byte{0x03, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF} + dev, err := open(vendorID, productID, serial) + if err != nil { + return nil, err + } + defer dev.Close() + _, err = dev.GetFeatureReport(report) + if err != nil { + return nil, err + } + r := report3.New(report) + _log(LogDebug, "read %v > %v", report, r) + return r, nil +} + +// WriteReport3 - get device configuration +func WriteReport3(vendorID uint16, productID uint16, serial string, report []byte) error { + + dev, err := open(vendorID, productID, serial) + if err != nil { + return err + } + defer dev.Close() + + _log(LogDebug, "write %v > %v", report, report3.New(report)) + _, err = dev.SendFeatureReport(report) + if err != nil { + return err + } + + return nil +} + +func _log(level LogLevel, format string, v ...interface{}) { + if level >= _logLevel { + log.Printf(format, v...) + } +} diff --git a/app/pkg/device/keycodes/keycodes.go b/app/pkg/device/keycodes/keycodes.go new file mode 100644 index 0000000..a0ffc7a --- /dev/null +++ b/app/pkg/device/keycodes/keycodes.go @@ -0,0 +1,175 @@ +// The contents of this file is free and unencumbered software released into +// the public domain. Refer to for more information. +// Src: https://github.com/yakshaveinc/go-keycodes/blob/master/keycodes.go + +package keycodes + +import "fmt" + +type KeyCode uint8 + +func (k KeyCode) String() string { + if k == KeyUnset { + return "unset" + } + return fmt.Sprintf("Key(%d)", k) +} + +// note: similar keys have different key codes, like Enter and +// Keypad Enter + +// cross-platform key codes, compatible with SDL 2 and USB HID speccy +// https://hg.libsdl.org/SDL/file/default/include/SDL_scancode.h +// http://www.usb.org/developers/hidpage/Hut1_12v2.pdf (page 53) + +// key for codes 0 - 3 are not present on keyboards, they are: +// 0 - Reserved (no event) +// 1 - ErrorRollOver +// 2 - POSTFail +// 3 - ErrorUndefined + +const ( + KeyA KeyCode = 4 + iota + KeyB + KeyC + KeyD + KeyE + KeyF + KeyG + KeyH + KeyI + KeyJ + KeyK + KeyL + KeyM + KeyN + KeyO + KeyP + KeyQ + KeyR + KeyS + KeyT + KeyU + KeyV + KeyW + KeyX + KeyY + KeyZ +) +const ( + Key1 KeyCode = 30 + iota + Key2 + Key3 + Key4 + Key5 + Key6 + Key7 + Key8 + Key9 + Key0 +) +const ( + // choice is to use Enter name instead of Return + // and the key code is different from Keypad Enter + KeyEnter KeyCode = 40 + iota + KeyEscape + KeyBackspace + KeyTab + KeySpace + // keypad minus has different key code + KeyMinus + KeyEquals + KeyLeftBracket + KeyRightBracket + KeyBackslash +) + +// key code number 50 is skipped, because it is unclear +// where is the key, and what is its name and function + +const ( + // different name from SDL2 for brevity + KeyColon KeyCode = 51 + iota + KeyApostrophe + // KeyTilde is an alias + KeyGrave + KeyCommad + // KeyDot is an alias, keypad period is a different + KeyPeriod + Slash + CapsLock +) +const KeyTilde = KeyGrave +const KeyDot = KeyPeriod + +const ( + KeyF1 KeyCode = 58 + iota + KeyF2 + KeyF3 + KeyF4 + KeyF5 + KeyF6 + KeyF7 + KeyF8 + KeyF9 + KeyF10 + KeyF11 + KeyF12 +) +const ( + KeyPrintScreen KeyCode = 70 + iota + KeyScrollLock + KeyPause + KeyInsert + KeyHome + KeyPageUp + KeyDelete + KeyEnd + KeyPageDown + KeyRight + KeyLeft + KeyDown + KeyUp +) +const ( + KeyNumLock KeyCode = 83 + iota + KeyKpDivide + KeyKpMultiply + KeyKpMinus + KeyKpPlus + KeyKpEnter + KeyKp1 + KeyKp2 + KeyKp3 + KeyKp4 + KeyKp5 + KeyKp6 + KeyKp7 + KeyKp8 + KeyKp9 + KeyKp0 + // KeyKpDot is an alias + KeyKpPeriod +) +const KeyKpDot = KeyKpPeriod + +// key code 100 is skipped, because I can not find the key +// key code 101 is not present on Mac +// key codes 102-223 are not present on PC + +const ( + KeyLCtrl KeyCode = 224 + iota + KeyLShift + KeyLAlt + // KeyLWin is an alias + KeyLGUI + KeyRCtrl + KeyRShift + KeyRAlt + // KeyRWin is an alias + KeyRGUI +) +const KeyLWin = KeyLGUI +const KeyRWin = KeyRGUI + +const KeyUnset = 255 diff --git a/app/pkg/device/report3/report3.go b/app/pkg/device/report3/report3.go new file mode 100644 index 0000000..be50e90 --- /dev/null +++ b/app/pkg/device/report3/report3.go @@ -0,0 +1,139 @@ +package report3 + +import ( + "fmt" + + "microjelly.com/beeon/app/pkg/device/keycodes" +) + +type State uint8 + +const ( + StateIdle = State(10) + StateActive = State(20) + StateUnset = State(255) +) + +func (r State) String() string { + switch r { + case StateActive: + return "active" + case StateIdle: + return "idle" + case StateUnset: + return "unset" + default: + return "unknown" + } +} + +type Mode uint8 + +const ( + ModeMouse = Mode(10) + ModeKeyboard = Mode(20) + ModeUnset = Mode(255) +) + +func (r Mode) String() string { + switch r { + case ModeMouse: + return "mouse" + case ModeKeyboard: + return "keyboard" + case ModeUnset: + return "unset" + default: + return "unknown" + } +} + +type Rate uint8 + +const ( + RateFast = Rate(1) + RateNormal = Rate(8) + RateSlow = Rate(16) + RateExtraSlow = Rate(32) + RateUnset = Rate(255) +) + +func (r Rate) String() string { + switch r { + case RateFast: + return "fast" + case RateNormal: + return "normal" + case RateSlow: + return "slow" + case RateExtraSlow: + return "extra-slow" + case RateUnset: + return "unset" + default: + return fmt.Sprintf("custom (%d)", r) + } +} + +type MouseMode uint8 + +const ( + MouseModeCircle = MouseMode(10) + MouseModeRandom = MouseMode(20) + MouseModeUnset = MouseMode(255) +) + +func (r MouseMode) String() string { + switch r { + case MouseModeCircle: + return "circle" + case MouseModeRandom: + return "random" + case MouseModeUnset: + return "unset" + default: + return "unknown" + } +} + +type Report struct { + State State + Mode Mode + Rate Rate + KeyCode keycodes.KeyCode + MouseMode MouseMode +} + +func (r Report) String() string { + switch r.Mode { + case ModeMouse: + return fmt.Sprintf("{Mode: %s, MouseMode: %s, Rate: %s, State: %s}", r.Mode, r.MouseMode, r.Rate, r.State) + case ModeKeyboard: + return fmt.Sprintf("{Mode: %s, KeyCode: %s, Rate: %s, State: %s}", r.Mode, r.KeyCode, r.Rate, r.State) + case ModeUnset: + return fmt.Sprintf("{Mode: %s, MouseMode: %s, KeyCode: %s, Rate: %s, State: %s}", r.Mode, r.MouseMode, r.KeyCode, r.Rate, r.State) + default: + return "{invalid}" + } +} + +func New(b []byte) *Report { + r := new(Report) + r.State = State(b[1]) + r.Mode = Mode(b[2]) + r.Rate = Rate(b[3]) + r.KeyCode = keycodes.KeyCode(b[4]) + r.MouseMode = MouseMode(b[5]) + return r +} + +func (r Report) Bytes() []byte { + b := make([]byte, 6) + b[0] = 3 + b[1] = uint8(r.State) + b[2] = uint8(r.Mode) + b[3] = uint8(r.Rate) + b[4] = uint8(r.KeyCode) + b[5] = uint8(r.MouseMode) + return b +} diff --git a/app/pkg/device/types.go b/app/pkg/device/types.go new file mode 100644 index 0000000..cd5ca54 --- /dev/null +++ b/app/pkg/device/types.go @@ -0,0 +1,21 @@ +package device + +// Info - short list of details +type Info struct { + Serial string + Manufacturer string + Version uint16 + Product string +} + +// LogLevel - something +type LogLevel uint + +// LogNone - disabled logging +// LogInfo - basic logging +// LogDebug - even more +const ( + LogDebug LogLevel = iota + LogInfo + LogNone +) diff --git a/classic/README.md b/classic/README.md new file mode 100644 index 0000000..3e0298d --- /dev/null +++ b/classic/README.md @@ -0,0 +1,59 @@ +[finished-product-image]: hw/img/classic-v1.jpg "BEEON - Classic; v1" +[pcb-top-image]: hw/img/classic-v1-top.png "BEEON - Classic; v1; pcb-top" +[pcb-bottom-image]: hw/img/classic-v1-bottom.png "BEEON - Classic; v1; pcb-bottom" + +# classic hardware + +## Overview +The classic device was created several years ago to fill a single need, preventing my work computer from auto locking due to inactivity. *Subverting security policy comes with a responsibility to ensure that you lock your computer (CTRL+ALT+DEL) everytime you walk away!* + +Alternatively the device can also be used as a low-pin USB development platform, by soldering a pin header to the exposed pads on the bottom you can access 3 GPIOS, VCC (3v3+), GND and the RESET pin of the ATTINY85. Making it a very low-pin count development board with USB capabilities. + +--- +## Firmware +The firmware makes use of the outstanding V-USB software-only implementation of low-speed USB devices. If you plan on making changes or releasing your own devices please change the vendor/device names as well as the vendor/product ids within the [usbconfig.h](fw/v1/usbconfig.h) file. + +`V-USB` is released under the [GPLv2](https://github.com/obdev/v-usb/blob/master/usbdrv/License.txt) license. + +--- +## Bootloader +Micronucleus is the bootloader that is currently in use by the beeon-classic devices. You will need a copy of the commandline tool for your operating system inorder to upload new firmware onto the device. v2.04 is the version that we are currently using. + +| OS | Link | +| -- | -- | +| Windows | [Download](https://github.com/micronucleus/micronucleus/raw/master/commandline/micronucleus.exe) | +| Linux/Darwin | [Build](https://github.com/micronucleus/micronucleus/tree/master/commandline) | +`Micronucleus` is released under the [GPLv2](https://github.com/micronucleus/micronucleus/blob/master/License.txt) license. + +--- +## BOM +| Reference(s) | Package | Description | Manufacturer | Part Number | **Cost | +| ------------ | -------: | ------------------------------ | ----------------- | -----------------: | -----: | +| SW1 | | Switch | E-Switch | *TL1014BF180QG | $#.## | +| D1 | 1206 | LED | OSRAM Opto | *LG N971-KN-1 | $#.## | +| J1 | | 6 PIN 2.54mm (Optional Header) | Harwin | M20-7820646 | $0.95 | +| J2 | | USB | CNC-Tech | 1001-011-01101 | $0.77 | +| R1 | 0805 | 47 Ohm Resistor | Vishay/Dale | CRCW080547R0FKEA | $0.10 | +| R2 | 0805 | 1K5 Ohm Resistor | Vishay/Dale | CRCW08051K50FKEB | $0.17 | +| R3 | 0805 | 68 Ohm Resistor | Vishay/Dale | CRCW080568R0FKEA | $0.10 | +| R4 | 0805 | 68 Ohm Resistor | Vishay/Dale | CRCW080568R0FKEA | $0.10 | +| U1 | SOIC-8 | ATtiny85 MCU | Atmel | ATtiny85-20SU | $1.13 | +| U2 | SOT-23-5 | 1 00mA 3.3 LDO | Texas Instruments | TPS79133DBVR | $1.32 | +| C1 | 1206 | 10uF 10v Tantalum Capacitor | AVX | F931A106KAA | $0.49 | +| C2 | 1206 | 0.1uF 10v MLCC Capacitor | Vishay/Vitramon | VJ1206Y104KXQPW1BC | $0.29 | +| C3 | 1206 | 0.01uF 10v MLCC Capacitor | Vishay/Vitramon | VJ1206Y103KXJCW1BC | $0.25 | +| C4 | 1206 | 1uF 16v Tantalum Capacitor | AVX | F931C105KAA | $0.51 | + +**obsolete part (need to find replacement)* +***cost last updated on 8/14/2020* + +--- +## PCB +[`Order from OSH Park`](https://oshpark.com/shared_projects/amtuUCdw) +![alt text][pcb-top-image] ![alt text][pcb-bottom-image] + +--- +## Finished Product +| ![alt text][finished-product-image] | +| :---------------------------------- | + diff --git a/classic/bl/.gitignore b/classic/bl/.gitignore new file mode 100644 index 0000000..05764df --- /dev/null +++ b/classic/bl/.gitignore @@ -0,0 +1 @@ +/work \ No newline at end of file diff --git a/classic/bl/Makefile b/classic/bl/Makefile new file mode 100644 index 0000000..b82ff9c --- /dev/null +++ b/classic/bl/Makefile @@ -0,0 +1,30 @@ +## +## +## + +MN_VERSION=2.04 + +.PHONY: help beeon + +help: ## This help. + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +.DEFAULT_GOAL := beeon + +work/: + @mkdir -p work + +work/${MN_VERSION}.tar.gz: work/ + @wget -O work/${MN_VERSION}.tar.gz https://github.com/micronucleus/micronucleus/archive/${MN_VERSION}.tar.gz + +work/micronucleus-${MN_VERSION}/firmware/Makefile: work/${MN_VERSION}.tar.gz + @echo "Unpacking/Patching micronucleus-${MN_VERSION}" + @cd work && tar zxf ${MN_VERSION}.tar.gz + @cp -r beeon/ work/micronucleus-${MN_VERSION}/firmware/configuration/ + +beeon: work/micronucleus-${MN_VERSION}/firmware/Makefile ## build bootloader + @echo "Building" + @make -C work/micronucleus-${MN_VERSION}/firmware CONFIG=beeon + +clean: + @rm -rf work \ No newline at end of file diff --git a/classic/bl/beeon/Makefile.inc b/classic/bl/beeon/Makefile.inc new file mode 100644 index 0000000..ee7252d --- /dev/null +++ b/classic/bl/beeon/Makefile.inc @@ -0,0 +1,60 @@ +# Name: Makefile +# Project: Micronucleus +# License: GNU GPL v2 (see License.txt) + +# Controller type: ATtiny 85 - 16.5 MHz +# Configuration: Default +# Last Change: Mar 16,2014 + + +F_CPU = 16500000 +DEVICE = attiny85 + +# hexadecimal address for bootloader section to begin. To calculate the best value: +# - make clean; make main.hex; ### output will list data: 2124 (or something like that) +# - for the size of your device (8kb = 1024 * 8 = 8192) subtract above value 2124... = 6068 +# - How many pages in is that? 6068 / 64 (tiny85 page size in bytes) = 94.8125 +# - round that down to 94 - our new bootloader address is 94 * 64 = 6016, in hex = 1780 +BOOTLOADER_ADDRESS = 1980 + +FUSEOPT = -U lfuse:w:0xe1:m -U hfuse:w:0xdd:m -U efuse:w:0xfe:m +FUSEOPT_DISABLERESET = -U lfuse:w:0xe1:m -U efuse:w:0xfe:m -U hfuse:w:0x5d:m + +#--------------------------------------------------------------------- +# ATtiny85 +#--------------------------------------------------------------------- +# Fuse extended byte: +# 0xFE = - - - - - 1 1 0 +# ^ +# | +# +---- SELFPRGEN (enable self programming flash) +# +# Fuse high byte: +# 0xdd = 1 1 0 1 1 1 0 1 +# ^ ^ ^ ^ ^ \-+-/ +# | | | | | +------ BODLEVEL 2..0 (brownout trigger level -> 2.7V) +# | | | | +---------- EESAVE (preserve EEPROM on Chip Erase -> not preserved) +# | | | +-------------- WDTON (watchdog timer always on -> disable) +# | | +---------------- SPIEN (enable serial programming -> enabled) +# | +------------------ DWEN (debug wire enable) +# +-------------------- RSTDISBL (disable external reset -> enabled) +# +# Fuse high byte ("no reset": external reset disabled, can't program through SPI anymore) +# 0x5d = 0 1 0 1 1 1 0 1 +# ^ ^ ^ ^ ^ \-+-/ +# | | | | | +------ BODLEVEL 2..0 (brownout trigger level -> 2.7V) +# | | | | +---------- EESAVE (preserve EEPROM on Chip Erase -> not preserved) +# | | | +-------------- WDTON (watchdog timer always on -> disable) +# | | +---------------- SPIEN (enable serial programming -> enabled) +# | +------------------ DWEN (debug wire enable) +# +-------------------- RSTDISBL (disable external reset -> disabled!) +# +# Fuse low byte: +# 0xe1 = 1 1 1 0 0 0 0 1 +# ^ ^ \+/ \--+--/ +# | | | +------- CKSEL 3..0 (clock selection -> HF PLL) +# | | +--------------- SUT 1..0 (BOD enabled, fast rising power) +# | +------------------ CKOUT (clock output on CKOUT pin -> disabled) +# +-------------------- CKDIV8 (divide clock by 8 -> don't divide) + +############################################################################### diff --git a/classic/bl/beeon/bootloaderconfig.h b/classic/bl/beeon/bootloaderconfig.h new file mode 100644 index 0000000..383bb1d --- /dev/null +++ b/classic/bl/beeon/bootloaderconfig.h @@ -0,0 +1,259 @@ +/* Name: bootloaderconfig.h + * Micronucleus configuration file. + * This file (together with some settings in Makefile.inc) configures the boot loader + * according to the hardware. + * + * Controller type: ATtiny 85 - 16.5 MHz + * Configuration: Default configuration + * USB D- : PB3 + * USB D+ : PB4 + * Entry : Always + * LED : None + * OSCCAL : Stays at 16 MHz + * Note: Uses 16.5 MHz V-USB implementation with PLL + * Last Change: Mar 16,2014 + * + * License: GNU GPL v2 (see License.txt + */ +#ifndef __bootloaderconfig_h_included__ +#define __bootloaderconfig_h_included__ + +/* ------------------------------------------------------------------------- */ +/* Hardware configuration. */ +/* Change this according to your CPU and USB configuration */ +/* ------------------------------------------------------------------------- */ + +#define USB_CFG_IOPORTNAME B + /* This is the port where the USB bus is connected. When you configure it to + * "B", the registers PORTB, PINB and DDRB will be used. + */ + +#define USB_CFG_DMINUS_BIT 3 +/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. + * This may be any bit in the port. + */ +#define USB_CFG_DPLUS_BIT 4 +/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. + * This may be any bit in the port, but must be configured as a pin change interrupt. + */ + +#define USB_CFG_CLOCK_KHZ (F_CPU/1000) +/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000, + * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code + * require no crystal, they tolerate +/- 1% deviation from the nominal + * frequency. All other rates require a precision of 2000 ppm and thus a + * crystal! + * Since F_CPU should be defined to your actual clock rate anyway, you should + * not need to modify this setting. + */ + +/* ------------- Set up interrupt configuration (CPU specific) -------------- */ +/* The register names change quite a bit in the ATtiny family. Pay attention */ +/* to the manual. Note that the interrupt flag system is still used even though */ +/* interrupts are disabled. So this has to be configured correctly. */ + + +// setup interrupt for Pin Change for D+ +#define USB_INTR_CFG PCMSK +#define USB_INTR_CFG_SET (1 << USB_CFG_DPLUS_BIT) +#define USB_INTR_CFG_CLR 0 +#define USB_INTR_ENABLE GIMSK +#define USB_INTR_ENABLE_BIT PCIE +#define USB_INTR_PENDING GIFR +#define USB_INTR_PENDING_BIT PCIF +#define USB_INTR_VECTOR PCINT0_vect + +/* ------------------------------------------------------------------------- */ +/* Configuration relevant to the CPU the bootloader is running on */ +/* ------------------------------------------------------------------------- */ + +// how many milliseconds should host wait till it sends another erase or write? +// needs to be above 4.5 (and a whole integer) as avr freezes for 4.5ms +#define MICRONUCLEUS_WRITE_SLEEP 5 + + +/* ---------------------- feature / code size options ---------------------- */ +/* Configure the behavior of the bootloader here */ +/* ------------------------------------------------------------------------- */ + +/* + * Define Bootloader entry condition + * + * If the entry condition is not met, the bootloader will not be activated and the user program + * is executed directly after a reset. If no user program has been loaded, the bootloader + * is always active. + * + * ENTRY_ALWAYS Always activate the bootloader after reset. Requires the least + * amount of code. + * + * ENTRY_WATCHDOG Activate the bootloader after a watchdog reset. This can be used + * to enter the bootloader from the user program. + * Adds 22 bytes. + * + * ENTRY_EXT_RESET Activate the bootloader after an external reset was issued by + * pulling the reset pin low. It may be necessary to add an external + * pull-up resistor to the reset pin if this entry method appears to + * behave unreliably. + * Adds 22 bytes. + * + * ENTRY_JUMPER Activate the bootloader when a specific pin is pulled low by an + * external jumper. + * Adds 34 bytes. + * + * JUMPER_PIN Pin the jumper is connected to. (e.g. PB0) + * JUMPER_PORT Port out register for the jumper (e.g. PORTB) + * JUMPER_DDR Port data direction register for the jumper (e.g. DDRB) + * JUMPER_INP Port inout register for the jumper (e.g. PINB) + * + */ + +#define ENTRYMODE ENTRY_JUMPER + +#define JUMPER_PIN PB2 +#define JUMPER_PORT PORTB +#define JUMPER_DDR DDRB +#define JUMPER_INP PINB + +/* + Internal implementation, don't change this unless you want to add an entrymode. +*/ + +#define ENTRY_ALWAYS 1 +#define ENTRY_WATCHDOG 2 +#define ENTRY_EXT_RESET 3 +#define ENTRY_JUMPER 4 + +#if ENTRYMODE==ENTRY_ALWAYS + #define bootLoaderInit() + #define bootLoaderExit() + #define bootLoaderStartCondition() 1 +#elif ENTRYMODE==ENTRY_WATCHDOG + #define bootLoaderInit() + #define bootLoaderExit() + #define bootLoaderStartCondition() (MCUSR&_BV(WDRF)) +#elif ENTRYMODE==ENTRY_EXT_RESET + #define bootLoaderInit() + #define bootLoaderExit() + #define bootLoaderStartCondition() (MCUSR&_BV(EXTRF)) +#elif ENTRYMODE==ENTRY_JUMPER + // Enable pull up on jumper pin and delay to stabilize input + #define bootLoaderInit() {JUMPER_DDR&=~_BV(JUMPER_PIN);JUMPER_PORT|=_BV(JUMPER_PIN);_delay_ms(1);} + #define bootLoaderExit() {JUMPER_PORT&=~_BV(JUMPER_PIN);} + #define bootLoaderStartCondition() (!(JUMPER_INP&_BV(JUMPER_PIN))) +#else + #error "No entry mode defined" +#endif + +/* + * Define bootloader timeout value. + * + * The bootloader will only time out if a user program was loaded. + * + * AUTO_EXIT_NO_USB_MS The bootloader will exit after this delay if no USB is connected. + * Set to 0 to disable + * Adds ~6 bytes. + * (This will wait for an USB SE0 reset from the host) + * + * AUTO_EXIT_MS The bootloader will exit after this delay if no USB communication + * from the host tool was received. + * Set to 0 to disable + * + * All values are approx. in milliseconds + */ + +#define AUTO_EXIT_NO_USB_MS 0 +#define AUTO_EXIT_MS 6000 + + /* + * Defines the setting of the RC-oscillator calibration after quitting the bootloader. (OSCCAL) + * + * OSCCAL_RESTORE_DEFAULT Set this to '1' to revert to OSCCAL factore calibration after bootlaoder exit. + * This is 8 MHz +/-2% on most devices or 16 MHz on the ATtiny 85 with activated PLL. + * Adds ~14 bytes. + * + * OSCCAL_SAVE_CALIB Set this to '1' to save the OSCCAL calibration during program upload. + * This value will be reloaded after reset and will also be used for the user + * program unless "OSCCAL_RESTORE_DEFAULT" is active. This allows calibrate the internal + * RC oscillator to the F_CPU target frequency +/-1% from the USB timing. Please note + * that only true if the ambient temperature does not change. + * Adds ~38 bytes. + * + * OSCCAL_HAVE_XTAL Set this to '1' if you have an external crystal oscillator. In this case no attempt + * will be made to calibrate the oscillator. You should deactivate both options above + * if you use this to avoid redundant code. + * + * If both options are selected, OSCCAL_RESTORE_DEFAULT takes precedence. + * + * If no option is selected, OSCCAL will be left untouched and stays at either factory calibration or F_CPU depending + * on whether the bootloader was activated. This will take the least memory. You can use this if your program + * comes with its own OSCCAL calibration or an external clock source is used. + */ + +#define OSCCAL_RESTORE_DEFAULT 0 +#define OSCCAL_SAVE_CALIB 1 +#define OSCCAL_HAVE_XTAL 0 + +/* + * Defines handling of an indicator LED while the bootloader is active. + * + * LED_MODE Define behavior of attached LED or suppress LED code. + * + * NONE Do not generate LED code (gains 18 bytes). + * ACTIVE_HIGH LED is on when output pin is high. This will toggle bettwen 1 and 0. + * ACTIVE_LOW LED is on when output pin is low. This will toggle between Z and 0. + * + * LED_DDR,LED_PORT,LED_PIN Where is your LED connected? + * + */ + +#define LED_MODE NONE + +#define LED_DDR DDRB +#define LED_PORT PORTB +#define LED_PIN PB1 + +/* + * This is the implementation of the LED code. Change the configuration above unless you want to + * change the led behavior + * + * LED_INIT Called once after bootloader entry + * LED_EXIT Called once during bootloader exit + * LED_MACRO Called in the main loop with the idle counter as parameter. + * Use to define pattern. +*/ + +#define NONE 0 +#define ACTIVE_HIGH 1 +#define ACTIVE_LOW 2 + +#if LED_MODE==ACTIVE_HIGH + #define LED_INIT(x) LED_DDR |= _BV(LED_PIN); + #define LED_EXIT(x) {LED_DDR &=~_BV(LED_PIN);LED_PORT &=~_BV(LED_PIN);} + #define LED_MACRO(x) if ( x & 0x4c ) {LED_PORT&=~_BV(LED_PIN);} else {LED_PORT|=_BV(LED_PIN);} +#elif LED_MODE==ACTIVE_LOW + #define LED_INIT(x) LED_PORT &=~_BV(LED_PIN); + #define LED_EXIT(x) LED_DDR &=~_BV(LED_PIN); + #define LED_MACRO(x) if ( x & 0x4c ) {LED_DDR&=~_BV(LED_PIN);} else {LED_DDR|=_BV(LED_PIN);} +#elif LED_MODE==NONE + #define LED_INIT(x) + #define LED_EXIT(x) + #define LED_MACRO(x) +#endif + +/* --------------------------------------------------------------------------- */ +/* Micronucleus internal configuration. Do not change anything below this line */ +/* --------------------------------------------------------------------------- */ + +// Microcontroller vectortable entries in the flash +#define RESET_VECTOR_OFFSET 0 + +// number of bytes before the boot loader vectors to store the tiny application vector table +#define TINYVECTOR_RESET_OFFSET 4 +#define TINYVECTOR_OSCCAL_OFFSET 6 + +/* ------------------------------------------------------------------------ */ +// postscript are the few bytes at the end of programmable memory which store tinyVectors +#define POSTSCRIPT_SIZE 6 +#define PROGMEM_SIZE (BOOTLOADER_ADDRESS - POSTSCRIPT_SIZE) /* max size of user program */ + +#endif /* __bootloader_h_included__ */ diff --git a/classic/build/.gitignore b/classic/build/.gitignore new file mode 100644 index 0000000..1a6fd01 --- /dev/null +++ b/classic/build/.gitignore @@ -0,0 +1,3 @@ +Dockerfile.dapper[0-9]* +.dapper +bin/ \ No newline at end of file diff --git a/classic/build/Dockerfile.dapper b/classic/build/Dockerfile.dapper new file mode 100644 index 0000000..ecc1b37 --- /dev/null +++ b/classic/build/Dockerfile.dapper @@ -0,0 +1,9 @@ +FROM golang:alpine3.12 +RUN apk --update add make git bash gcc-avr avr-libc + +ENV DAPPER_SOURCE /source +ENV DAPPER_OUTPUT ./build/bin +WORKDIR ${DAPPER_SOURCE} + +ENTRYPOINT ["./build/scripts/entry"] +CMD ["beeon"] \ No newline at end of file diff --git a/classic/build/Makefile b/classic/build/Makefile new file mode 100644 index 0000000..0e169c0 --- /dev/null +++ b/classic/build/Makefile @@ -0,0 +1,22 @@ +TARGETS := $(shell ls scripts) + +.dapper: + @echo Downloading dapper + @curl -sL https://releases.rancher.com/dapper/latest/dapper-`uname -s`-`uname -m` > .dapper.tmp + @@chmod +x .dapper.tmp + @./.dapper.tmp -v + @mv .dapper.tmp .dapper + +$(TARGETS): .dapper + cd ../ && $(PWD)/.dapper -f build/Dockerfile.dapper $@ + @yes | docker image prune > /dev/null + +.PHONY: $(TARGETS) +.DEFAULT_GOAL := beeon + +clean: + @rm -rf $(PWD)/bin $(PWD)/.dapper $(PWD)/Dockerfile.dapper[0-9]* + @docker rmi classic:master + +shell-bind: .dapper + cd ../ && $(PWD)/.dapper -f build/Dockerfile.dapper -m bind -s \ No newline at end of file diff --git a/classic/build/scripts/beeon b/classic/build/scripts/beeon new file mode 100755 index 0000000..18a5d84 --- /dev/null +++ b/classic/build/scripts/beeon @@ -0,0 +1,18 @@ +#!/bin/bash +set -e + +# micronucleus bootloader (v1 hardware) +MN_VERSION=2.04 +make -C bl +cp bl/work/micronucleus-${MN_VERSION}/firmware/main.hex ${DAPPER_OUTPUT}/beeon-classic-v1-micronucleus-${MN_VERSION}.hex +ls -la ${DAPPER_OUTPUT}/beeon-classic-v1-micronucleus-${MN_VERSION}.hex + +# classic v1 firmware +make -C fw +cp fw/main.hex ${DAPPER_OUTPUT}/beeon-classic-v1.hex +ls -al ${DAPPER_OUTPUT}/beeon-classic-v1.hex + +## firmware serial number patcher +make -C sn +cp sn/bin/* ${DAPPER_OUTPUT}/ +ls -la ${DAPPER_OUTPUT}/beeon-classic-sn-* diff --git a/classic/build/scripts/entry b/classic/build/scripts/entry new file mode 100755 index 0000000..8c92812 --- /dev/null +++ b/classic/build/scripts/entry @@ -0,0 +1,13 @@ +#!/bin/bash +set -e + +DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" + +mkdir -p ${DAPPER_OUTPUT} +if [ -e ${DIR}/$1 ]; then + ${DIR}/"$@" +else + exec "$@" +fi + +chown -R $DAPPER_UID:$DAPPER_GID ${DAPPER_OUTPUT} \ No newline at end of file diff --git a/classic/fw/Makefile b/classic/fw/Makefile new file mode 100644 index 0000000..33ef4a5 --- /dev/null +++ b/classic/fw/Makefile @@ -0,0 +1,41 @@ +DEVICE = attiny85 +F_CPU = 16500000 + +CFLAGS = -Iusbdrv -I. -DDEBUG_LEVEL=0 +OBJECTS = usbdrv/usbdrv.o usbdrv/usbdrvasm.o usbdrv/oddebug.o main.o +COMPILE = avr-gcc -Wall -Os -DF_CPU=$(F_CPU) $(CFLAGS) -mmcu=$(DEVICE) + +.PHONY: help beeon + +help: ## This help. + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +.DEFAULT_GOAL := beeon + +beeon: main.hex ## build firmware + @echo "done" + +main.hex: main.elf + avr-objcopy -j .text -j .data -O ihex main.elf main.hex + avr-size main.hex + +main.elf: $(OBJECTS) + $(COMPILE) -o main.elf $(OBJECTS) + +clean: ## cleanup build output + -rm -f main.hex main.lst main.obj main.cof main.list main.map main.eep.hex main.elf *.o usbdrv/*.o main.s usbdrv/oddebug.s usbdrv/usbdrv.s + +usbdrv/usbdrv.o: + $(COMPILE) $(SERIAL) -c usbdrv/usbdrv.c -o $@ + +.c.o: + $(COMPILE) -c $< -o $@ + +.S.o: + $(COMPILE) -x assembler-with-cpp -c $< -o $@ + +.c.s: + $(COMPILE) -S $< -o $@ + +cpp: + $(COMPILE) -E main.c diff --git a/classic/fw/main.c b/classic/fw/main.c new file mode 100644 index 0000000..388f293 --- /dev/null +++ b/classic/fw/main.c @@ -0,0 +1,458 @@ +#include +#include +#include +#include /* for sei() */ +#include /* for _delay_ms() */ +#include + +#include /* required by usbdrv.h */ +#include "usbdrv.h" + +#define BIT_KEY 2 +#define BIT_LED 1 + +#define EEPROM_OSC 0 +#define EEPROM_DM 1 +#define EEPROM_DR 2 +#define EEPROM_KK 3 +#define EEPROM_MM 4 + +#define MOUSE_B 1 +#define MOUSE_X 2 +#define MOUSE_Y 3 +#define MOUSE_W 4 + +#define DS_IDLE 10 +#define DS_ACTIVE 20 + +#define DR_FAST 1 +#define DR_NORMAL 8 +#define DR_SLOW 16 +#define DR_EXSLOW 32 + +#define DM_MOUSE 10 +#define DM_KEYBOARD 20 + +#define MM_CIRCLE 10 +#define MM_RANDOM 20 + +#define LED_MAX 9 + +#define FR_DS 1 +#define FR_DM 2 +#define FR_DR 3 +#define FR_KK 4 +#define FR_MM 5 + +#define KK_0 0x27 +#define KK_CAPS 0x39 +#define KK_DEFAULT KK_0 + +/* ------------------------------------------------------------------------- */ +/* ----------------------------- USB interface ----------------------------- */ +/* ------------------------------------------------------------------------- */ + +PROGMEM const char usbHidReportDescriptor[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] = { + +// Mouse +// ------------------------------------------------------------------------- + 0x05, 0x01,// Usage Page (Generic Desktop), | + 0x09, 0x02,// Usage (Mouse), | + 0xA1, 0x01,// Collection (Application), | + 0x09, 0x01,// Usage (Pointer) | + 0xA1, 0x00,// Collection (Physical), | +// ------------------------------------------------------------------------- + 0x85, 0x01,// Report Id (1). | +// ------------------------------------------------------------------------- + 0x05, 0x09,// Usage Page (Buttons), | + 0x19, 0x01,// Usage Minimum (01), | + 0x29, 0x03,// Usage Maximun (03), | + 0x15, 0x00,// Logical Minimum (0), | + 0x25, 0x01,// Logical Maximum (1), | + 0x95, 0x03,// Report Count (3), | + 0x75, 0x01,// Report Size (1), | + 0x81, 0x02,// Input (Data, Var, Abs), | + 0x95, 0x01,// Report Count (1), | + 0x75, 0x05,// Report Size (5), | + 0x81, 0x03,// Input (Constant), ;5 bit padding | +// ------------------------------------------------------------------------- + 0x05, 0x01,// Usage Page (Generic Desktop), | + 0x09, 0x30,// Usage (X), | + 0x09, 0x31,// Usage (Y), | + 0x09, 0x38,// Usage (Wheel), | + 0x15, 0x81,// Logical Minimum (-127), | + 0x25, 0x7F,// Logical Maximum (127), | + 0x75, 0x08,// Report Size (8), | + 0x95, 0x03,// Report Count (3), | + 0x81, 0x06,// Input (Data, Var, Rel) | +// ------------------------------------------------------------------------- + 0xC0,// End Collection, | +// ------------------------------------------------------------------------- +// Configuration interface +// ------------------------------------------------------------------------- + 0x09, 0x00,// USAGE (Vendor Usage 1) | +// ------------------------------------------------------------------------- + 0x85, 0x03,// Report Id (3) | +// ------------------------------------------------------------------------- + 0x15, 0x00,// LOGICAL_MINIMUM (0) | + 0x26, 0xff, 0x00,// LOGICAL_MAXIMUM (255) | + 0x75, 0x08,// REPORT_SIZE (8) | + 0x95, 0x05,// REPORT_COUNT (5) | + 0xb1, 0x02,// FEATURE (Data,Var,Abs) | + 0xC0,// End Collection | +// ------------------------------------------------------------------------- + +// Keyboard +// ------------------------------------------------------------------------- + 0x05, 0x01,// USAGE_PAGE (Generic Desktop) | + 0x09, 0x06,// USAGE (Keyboard) | + 0xa1, 0x01,// COLLECTION (Application) | +// ------------------------------------------------------------------------- + 0x85, 0x02,// Report Id (2) | +// ------------------------------------------------------------------------- + 0x05, 0x07,// USAGE_PAGE (Keyboard) | + 0x19, 0xe0,// USAGE_MINIMUM (Keyboard LeftControl) | + 0x29, 0xe7,// USAGE_MAXIMUM (Keyboard Right GUI) | + 0x15, 0x00,// LOGICAL_MINIMUM (0) | + 0x25, 0x01,// LOGICAL_MAXIMUM (1) | + 0x75, 0x01,// REPORT_SIZE (1) | + 0x95, 0x08,// REPORT_COUNT (8) | + 0x81, 0x02,// INPUT (Data,Var,Abs) | +// ------------------------------------------------------------------------- + 0x95, 0x05,// REPORT_COUNT (5) | + 0x75, 0x01,// REPORT_SIZE (1) | + 0x05, 0x08,// USAGE_PAGE (LEDs) | + 0x19, 0x01,// USAGE_MINIMUM (Num Lock) | + 0x29, 0x05,// USAGE_MAXIMUM (Kana) | + 0x91, 0x02,// OUTPUT (Data,Var,Abs) | +// ------------------------------------------------------------------------- + 0x95, 0x01,// REPORT_COUNT (1) | + 0x75, 0x03,// REPORT_SIZE (3) | + 0x91, 0x03,// OUTPUT (Cnst,Var,Abs) | +// ------------------------------------------------------------------------- + 0x95, 0x06,// REPORT_COUNT (6) | + 0x75, 0x08,// REPORT_SIZE (8) | + 0x15, 0x00,// LOGICAL_MINIMUM (0) | + 0x25, 0x65,// LOGICAL_MAXIMUM (101) | + 0x05, 0x07,// USAGE_PAGE (Keyboard) | + 0x19, 0x00,// USAGE_MINIMUM (Reserved (no event indicated)) | + 0x29, 0x65,// USAGE_MAXIMUM (Keyboard Application) | + 0x81, 0x00,// INPUT (Data,Ary,Abs) | +// ------------------------------------------------------------------------- + 0xc0,// END_COLLECTION | +// ------------------------------------------------------------------------- +}; + + + +static uchar currentAddress; +static uchar bytesRemaining; + +static uchar mouseReportBuffer[5] = { 1, 0,0,0,0 }; +static uchar keyboardReportBuffer[8] = { 2, 0,0,0,0,0,0,0 }; +static uchar featureReportBuffer[6] = { 3, 0,0,0,0,0 }; + +static int sinus = 7 << 6, cosinus = 0; +static uchar idleRate; /* repeat rate for keyboards, never used for mice */ + +static uchar deviceStatus = DS_IDLE; +static uchar deviceRate = DR_NORMAL; +static uchar deviceMode = DM_MOUSE; +static uchar mouseMode = MM_RANDOM; +static uchar keyboardKey = KK_DEFAULT; +static uchar runToken = 1; + +static void toggleDeviceStatus() +{ + if(deviceStatus==DS_ACTIVE){ + + deviceStatus = DS_IDLE; + PORTB |= 1 << BIT_LED; /* LED on */ + }else{ + + deviceStatus = DS_ACTIVE; + PORTB &= ~(1 << BIT_LED); /* LED off */ + } +} + + +static void keyPoll(void) +{ +static uchar keyMirror; +uchar key; + + key = PINB & (1 << BIT_KEY); + if(keyMirror != key){ /* status changed */ + keyMirror = key; + if(!key) toggleDeviceStatus(); + } +} + +static void timerPoll(void) +{ +static int timerCnt; +static int timerCnt2; +static int timerLed; + + if(TIFR & (1 << TOV1)){ + TIFR = (1 << TOV1); /* clear overflow */ + keyPoll(); + if(++timerCnt >= deviceRate){ + timerCnt = 0; + if(++timerCnt2 >= deviceRate){ + timerCnt2 = 0; + runToken = 1; + } + } + if(++timerLed >= LED_MAX){ + timerLed = 0; + if(deviceStatus==DS_ACTIVE && (PINB & (1 << BIT_KEY)) ){ + PORTB &= ~(1 << BIT_LED); /* LED off */ + } + } + } +} + +/* The following function advances sin/cos by a fixed angle + * and stores the difference to the previous coordinates in the report + * descriptor. + * The algorithm is the simulation of a second order differential equation. + */ +static void advanceCircleByFixedAngle(void) +{ +char d; + +#define DIVIDE_BY_64(val) (val + (val > 0 ? 32 : -32)) >> 6 /* rounding divide */ + + mouseReportBuffer[MOUSE_X] = d = DIVIDE_BY_64(cosinus); + sinus += d; + mouseReportBuffer[MOUSE_Y] = d = DIVIDE_BY_64(sinus); + cosinus -= d; +} + +static void randomMouse(void) +{ + + mouseReportBuffer[MOUSE_X] = ((rand() / (RAND_MAX / 254 + 1))-128)/8; + mouseReportBuffer[MOUSE_Y] = ((rand() / (RAND_MAX / 254 + 1))-128)/8; +} + +/* ------------------------------------------------------------------------- */ + +/* usbFunctionWrite() is called when the host sends a chunk of data to the + * device. For more information see the documentation in usbdrv/usbdrv.h. + */ +uchar usbFunctionWrite(uchar *data, uchar len) { + + uchar i; + + if(bytesRemaining == 0) + return 1; /* end of transfer */ + if(len > bytesRemaining) + len = bytesRemaining; + + for(i = 0; i < len; i++) { + + if(currentAddress==FR_DS && data[i]!=0xff && data[i]!=deviceStatus) toggleDeviceStatus(); + else if(currentAddress==FR_DM && data[i]!=0xff && data[i]!=deviceMode && (data[i]==DM_MOUSE||data[i]==DM_KEYBOARD) ) { + eeprom_write_byte(EEPROM_DM, data[i]); + deviceMode=data[i]; + } else if(currentAddress==FR_DR && data[i]!=0xff && data[i]!=deviceRate) { + eeprom_write_byte(EEPROM_DR, data[i]); + deviceRate=data[i]; + } else if(currentAddress==FR_KK && data[i]!=0xff && data[i]!=keyboardKey) { + eeprom_write_byte(EEPROM_KK, data[i]); + keyboardKey=data[i]; + } else if(currentAddress==FR_MM && data[i]!=0xff && data[i]!=mouseMode && (data[i]==MM_CIRCLE||data[i]==MM_RANDOM) ) { + eeprom_write_byte(EEPROM_MM, data[i]); + mouseMode=data[i]; + } + + currentAddress++; + } + + currentAddress += len; + bytesRemaining -= len; + return bytesRemaining == 0; /* return 1 if this was the last chunk */ +} + +usbMsgLen_t usbFunctionSetup(uchar data[8]) +{ +usbRequest_t *rq = (void *)data; + + /* The following requests are never used. But since they are required by + * the specification, we implement them in this example. + */ + if((rq->bmRequestType & USBRQ_TYPE_MASK) == USBRQ_TYPE_CLASS){ /* class request type */ + if(rq->bRequest == USBRQ_HID_GET_REPORT){ + /* wValue: ReportType (highbyte), ReportID (lowbyte) */ + if (rq->wValue.bytes[0] == 1) { + usbMsgPtr = (void *)&mouseReportBuffer; + return sizeof(mouseReportBuffer); + } else if (rq->wValue.bytes[0] == 2) { + usbMsgPtr = (void *)&keyboardReportBuffer; + return sizeof(keyboardReportBuffer); + } else if (rq->wValue.bytes[0] == 3) { + featureReportBuffer[FR_DS] = deviceStatus; + featureReportBuffer[FR_DM] = deviceMode; + featureReportBuffer[FR_DR] = deviceRate; + featureReportBuffer[FR_KK] = keyboardKey; + featureReportBuffer[FR_MM] = mouseMode; + usbMsgPtr = (void *)&featureReportBuffer; + return sizeof(featureReportBuffer); + } + return 0; + } else if(rq->bRequest == USBRQ_HID_SET_REPORT){ + if (rq->wValue.bytes[0] == 3) { + bytesRemaining = rq->wLength.word; + currentAddress = 0; + return USB_NO_MSG; + } + } else if(rq->bRequest == USBRQ_HID_GET_IDLE){ + usbMsgPtr = &idleRate; + return 1; + }else if(rq->bRequest == USBRQ_HID_SET_IDLE){ + idleRate = rq->wValue.bytes[1]; + } + }else{ + /* no vendor specific requests implemented */ + } + return 0; /* default for not implemented requests: return no data back to host */ +} + +/* ------------------------------------------------------------------------- */ + +/* ------------------------------------------------------------------------- */ +/* ------------------------ Oscillator Calibration ------------------------- */ +/* ------------------------------------------------------------------------- */ + +/* Calibrate the RC oscillator to 8.25 MHz. The core clock of 16.5 MHz is + * derived from the 66 MHz peripheral clock by dividing. Our timing reference + * is the Start Of Frame signal (a single SE0 bit) available immediately after + * a USB RESET. We first do a binary search for the OSCCAL value and then + * optimize this value with a neighboorhod search. + * This algorithm may also be used to calibrate the RC oscillator directly to + * 12 MHz (no PLL involved, can therefore be used on almost ALL AVRs), but this + * is wide outside the spec for the OSCCAL value and the required precision for + * the 12 MHz clock! Use the RC oscillator calibrated to 12 MHz for + * experimental purposes only! + */ +static void calibrateOscillator(void) +{ +uchar step = 128; +uchar trialValue = 0, optimumValue; +int x, optimumDev, targetValue = (unsigned)(1499 * (double)F_CPU / 10.5e6 + 0.5); + + /* do a binary search: */ + do{ + OSCCAL = trialValue + step; + x = usbMeasureFrameLength(); /* proportional to current real frequency */ + if(x < targetValue) /* frequency still too low */ + trialValue += step; + step >>= 1; + }while(step > 0); + /* We have a precision of +/- 1 for optimum OSCCAL here */ + /* now do a neighborhood search for optimum value */ + optimumValue = trialValue; + optimumDev = x; /* this is certainly far away from optimum */ + for(OSCCAL = trialValue - 1; OSCCAL <= trialValue + 1; OSCCAL++){ + x = usbMeasureFrameLength() - targetValue; + if(x < 0) + x = -x; + if(x < optimumDev){ + optimumDev = x; + optimumValue = OSCCAL; + } + } + OSCCAL = optimumValue; +} +/* +Note: This calibration algorithm may try OSCCAL values of up to 192 even if +the optimum value is far below 192. It may therefore exceed the allowed clock +frequency of the CPU in low voltage designs! +You may replace this search algorithm with any other algorithm you like if +you have additional constraints such as a maximum CPU clock. +For version 5.x RC oscillators (those with a split range of 2x128 steps, e.g. +ATTiny25, ATTiny45, ATTiny85), it may be useful to search for the optimum in +both regions. +*/ + +void hadUsbReset(void) +{ + calibrateOscillator(); + eeprom_write_byte(EEPROM_OSC, OSCCAL); /* store the calibrated value in EEPROM */ +} + +static void timerInit(void) +{ + TCCR1 = 0x0b; /* select clock: 16.5M/1k -> overflow rate = 16.5M/256k = 62.94 Hz */ +} + +int __attribute__((noreturn)) main(void) +{ +uchar i; +uchar calibrationValue; + + PORTB |= 1 << BIT_KEY; /* pull-up on key input */ + DDRB |= 1 << BIT_LED; /* output for LED */ + + calibrationValue = eeprom_read_byte(EEPROM_OSC); /* calibration value from last time */ + if(calibrationValue != 0xff){ + OSCCAL = calibrationValue; + } + + i = eeprom_read_byte(EEPROM_DM); + if(i != 0xff) deviceMode = i; + + i = eeprom_read_byte(EEPROM_DR); + if(i != 0xff) deviceRate = i; + else deviceRate = DR_EXSLOW; + + i = eeprom_read_byte(EEPROM_KK); + if(i != 0xff) keyboardKey = i; + + i = eeprom_read_byte(EEPROM_MM); + if(i != 0xff) mouseMode = i; + + usbInit(); + usbDeviceDisconnect(); /* enforce re-enumeration, do this while interrupts are disabled! */ + for(i=0;i<20;i++){ /* 300 ms disconnect */ + _delay_ms(15); + } + usbDeviceConnect(); + + wdt_enable(WDTO_1S); + + timerInit(); + usbInit(); + sei(); + + PORTB |= 1 << BIT_LED; /* LED on */ + + for(;;){ /* main event loop */ + wdt_reset(); + usbPoll(); + if(usbInterruptIsReady() && keyboardReportBuffer[2]!=0) { + + keyboardReportBuffer[2] = 0; + usbSetInterrupt((void *)&keyboardReportBuffer, sizeof(keyboardReportBuffer)); + } else if(usbInterruptIsReady() && (deviceStatus==DS_ACTIVE) && runToken){ + + if(deviceMode==DM_MOUSE) { + + if(mouseMode==MM_CIRCLE) advanceCircleByFixedAngle(); + else randomMouse(); + PORTB |= 1 << BIT_LED; /* LED on */ + usbSetInterrupt((void *)&mouseReportBuffer, sizeof(mouseReportBuffer)); + } else { + + keyboardReportBuffer[2] = keyboardKey; + usbSetInterrupt((void *)&keyboardReportBuffer, sizeof(keyboardReportBuffer)); + } + runToken = 0; + } + timerPoll(); + } +} + +/* ------------------------------------------------------------------------- */ diff --git a/classic/fw/usbconfig.h b/classic/fw/usbconfig.h new file mode 100644 index 0000000..ce1cb6f --- /dev/null +++ b/classic/fw/usbconfig.h @@ -0,0 +1,394 @@ +/* Name: usbconfig.h + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Christian Starkjohann + * Creation Date: 2005-04-01 + * Tabsize: 4 + * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +#ifndef __usbconfig_h_included__ +#define __usbconfig_h_included__ + +/* +General Description: +This file is an example configuration (with inline documentation) for the USB +driver. It configures V-USB for USB D+ connected to Port D bit 2 (which is +also hardware interrupt 0 on many devices) and USB D- to Port D bit 4. You may +wire the lines to any other port, as long as D+ is also wired to INT0 (or any +other hardware interrupt, as long as it is the highest level interrupt, see +section at the end of this file). +*/ + +/* ---------------------------- Hardware Config ---------------------------- */ + +#define USB_CFG_IOPORTNAME B +/* This is the port where the USB bus is connected. When you configure it to + * "B", the registers PORTB, PINB and DDRB will be used. + */ +#define USB_CFG_DMINUS_BIT 3 +/* This is the bit number in USB_CFG_IOPORT where the USB D- line is connected. + * This may be any bit in the port. + */ +#define USB_CFG_DPLUS_BIT 4 +/* This is the bit number in USB_CFG_IOPORT where the USB D+ line is connected. + * This may be any bit in the port. Please note that D+ must also be connected + * to interrupt pin INT0! [You can also use other interrupts, see section + * "Optional MCU Description" below, or you can connect D- to the interrupt, as + * it is required if you use the USB_COUNT_SOF feature. If you use D- for the + * interrupt, the USB interrupt will also be triggered at Start-Of-Frame + * markers every millisecond.] + */ +#define USB_CFG_CLOCK_KHZ (F_CPU/1000) +/* Clock rate of the AVR in kHz. Legal values are 12000, 12800, 15000, 16000, + * 16500, 18000 and 20000. The 12.8 MHz and 16.5 MHz versions of the code + * require no crystal, they tolerate +/- 1% deviation from the nominal + * frequency. All other rates require a precision of 2000 ppm and thus a + * crystal! + * Since F_CPU should be defined to your actual clock rate anyway, you should + * not need to modify this setting. + */ +#define USB_CFG_CHECK_CRC 0 +/* Define this to 1 if you want that the driver checks integrity of incoming + * data packets (CRC checks). CRC checks cost quite a bit of code size and are + * currently only available for 18 MHz crystal clock. You must choose + * USB_CFG_CLOCK_KHZ = 18000 if you enable this option. + */ + +/* ----------------------- Optional Hardware Config ------------------------ */ + +/* #define USB_CFG_PULLUP_IOPORTNAME D */ +/* If you connect the 1.5k pullup resistor from D- to a port pin instead of + * V+, you can connect and disconnect the device from firmware by calling + * the macros usbDeviceConnect() and usbDeviceDisconnect() (see usbdrv.h). + * This constant defines the port on which the pullup resistor is connected. + */ +/* #define USB_CFG_PULLUP_BIT 4 */ +/* This constant defines the bit number in USB_CFG_PULLUP_IOPORT (defined + * above) where the 1.5k pullup resistor is connected. See description + * above for details. + */ + +/* --------------------------- Functional Range ---------------------------- */ + +#define USB_CFG_HAVE_INTRIN_ENDPOINT 1 +/* Define this to 1 if you want to compile a version with two endpoints: The + * default control endpoint 0 and an interrupt-in endpoint (any other endpoint + * number). + */ +#define USB_CFG_HAVE_INTRIN_ENDPOINT3 0 +/* Define this to 1 if you want to compile a version with three endpoints: The + * default control endpoint 0, an interrupt-in endpoint 3 (or the number + * configured below) and a catch-all default interrupt-in endpoint as above. + * You must also define USB_CFG_HAVE_INTRIN_ENDPOINT to 1 for this feature. + */ +#define USB_CFG_EP3_NUMBER 3 +/* If the so-called endpoint 3 is used, it can now be configured to any other + * endpoint number (except 0) with this macro. Default if undefined is 3. + */ +/* #define USB_INITIAL_DATATOKEN USBPID_DATA1 */ +/* The above macro defines the startup condition for data toggling on the + * interrupt/bulk endpoints 1 and 3. Defaults to USBPID_DATA1. + * Since the token is toggled BEFORE sending any data, the first packet is + * sent with the oposite value of this configuration! + */ +#define USB_CFG_IMPLEMENT_HALT 0 +/* Define this to 1 if you also want to implement the ENDPOINT_HALT feature + * for endpoint 1 (interrupt endpoint). Although you may not need this feature, + * it is required by the standard. We have made it a config option because it + * bloats the code considerably. + */ +#define USB_CFG_SUPPRESS_INTR_CODE 0 +/* Define this to 1 if you want to declare interrupt-in endpoints, but don't + * want to send any data over them. If this macro is defined to 1, functions + * usbSetInterrupt() and usbSetInterrupt3() are omitted. This is useful if + * you need the interrupt-in endpoints in order to comply to an interface + * (e.g. HID), but never want to send any data. This option saves a couple + * of bytes in flash memory and the transmit buffers in RAM. + */ +#define USB_CFG_INTR_POLL_INTERVAL 50 +/* If you compile a version with endpoint 1 (interrupt-in), this is the poll + * interval. The value is in milliseconds and must not be less than 10 ms for + * low speed devices. + */ +#define USB_CFG_IS_SELF_POWERED 0 +/* Define this to 1 if the device has its own power supply. Set it to 0 if the + * device is powered from the USB bus. + */ +#define USB_CFG_MAX_BUS_POWER 50 +/* Set this variable to the maximum USB bus power consumption of your device. + * The value is in milliamperes. [It will be divided by two since USB + * communicates power requirements in units of 2 mA.] + */ +#define USB_CFG_IMPLEMENT_FN_WRITE 1 +/* Set this to 1 if you want usbFunctionWrite() to be called for control-out + * transfers. Set it to 0 if you don't need it and want to save a couple of + * bytes. + */ +#define USB_CFG_IMPLEMENT_FN_READ 0 +/* Set this to 1 if you need to send control replies which are generated + * "on the fly" when usbFunctionRead() is called. If you only want to send + * data from a static buffer, set it to 0 and return the data from + * usbFunctionSetup(). This saves a couple of bytes. + */ +#define USB_CFG_IMPLEMENT_FN_WRITEOUT 0 +/* Define this to 1 if you want to use interrupt-out (or bulk out) endpoints. + * You must implement the function usbFunctionWriteOut() which receives all + * interrupt/bulk data sent to any endpoint other than 0. The endpoint number + * can be found in 'usbRxToken'. + */ +#define USB_CFG_HAVE_FLOWCONTROL 0 +/* Define this to 1 if you want flowcontrol over USB data. See the definition + * of the macros usbDisableAllRequests() and usbEnableAllRequests() in + * usbdrv.h. + */ +#define USB_CFG_DRIVER_FLASH_PAGE 0 +/* If the device has more than 64 kBytes of flash, define this to the 64 k page + * where the driver's constants (descriptors) are located. Or in other words: + * Define this to 1 for boot loaders on the ATMega128. + */ +#define USB_CFG_LONG_TRANSFERS 0 +/* Define this to 1 if you want to send/receive blocks of more than 254 bytes + * in a single control-in or control-out transfer. Note that the capability + * for long transfers increases the driver size. + */ +/* #define USB_RX_USER_HOOK(data, len) if(usbRxToken == (uchar)USBPID_SETUP) blinkLED(); */ +/* This macro is a hook if you want to do unconventional things. If it is + * defined, it's inserted at the beginning of received message processing. + * If you eat the received message and don't want default processing to + * proceed, do a return after doing your things. One possible application + * (besides debugging) is to flash a status LED on each packet. + */ +#define USB_RESET_HOOK(resetStarts) if(!resetStarts){hadUsbReset();} +/* This macro is a hook if you need to know when an USB RESET occurs. It has + * one parameter which distinguishes between the start of RESET state and its + * end. + */ +/* #define USB_SET_ADDRESS_HOOK() hadAddressAssigned(); */ +/* This macro (if defined) is executed when a USB SET_ADDRESS request was + * received. + */ +#define USB_COUNT_SOF 0 +/* define this macro to 1 if you need the global variable "usbSofCount" which + * counts SOF packets. This feature requires that the hardware interrupt is + * connected to D- instead of D+. + */ +/* #ifdef __ASSEMBLER__ + * macro myAssemblerMacro + * in YL, TCNT0 + * sts timer0Snapshot, YL + * endm + * #endif + * #define USB_SOF_HOOK myAssemblerMacro + * This macro (if defined) is executed in the assembler module when a + * Start Of Frame condition is detected. It is recommended to define it to + * the name of an assembler macro which is defined here as well so that more + * than one assembler instruction can be used. The macro may use the register + * YL and modify SREG. If it lasts longer than a couple of cycles, USB messages + * immediately after an SOF pulse may be lost and must be retried by the host. + * What can you do with this hook? Since the SOF signal occurs exactly every + * 1 ms (unless the host is in sleep mode), you can use it to tune OSCCAL in + * designs running on the internal RC oscillator. + * Please note that Start Of Frame detection works only if D- is wired to the + * interrupt, not D+. THIS IS DIFFERENT THAN MOST EXAMPLES! + */ +#define USB_CFG_CHECK_DATA_TOGGLING 0 +/* define this macro to 1 if you want to filter out duplicate data packets + * sent by the host. Duplicates occur only as a consequence of communication + * errors, when the host does not receive an ACK. Please note that you need to + * implement the filtering yourself in usbFunctionWriteOut() and + * usbFunctionWrite(). Use the global usbCurrentDataToken and a static variable + * for each control- and out-endpoint to check for duplicate packets. + */ +#define USB_CFG_HAVE_MEASURE_FRAME_LENGTH 1 +/* define this macro to 1 if you want the function usbMeasureFrameLength() + * compiled in. This function can be used to calibrate the AVR's RC oscillator. + */ +#define USB_USE_FAST_CRC 0 +/* The assembler module has two implementations for the CRC algorithm. One is + * faster, the other is smaller. This CRC routine is only used for transmitted + * messages where timing is not critical. The faster routine needs 31 cycles + * per byte while the smaller one needs 61 to 69 cycles. The faster routine + * may be worth the 32 bytes bigger code size if you transmit lots of data and + * run the AVR close to its limit. + */ + +/* -------------------------- Device Description --------------------------- */ + +#define USB_CFG_VENDOR_ID 0xd0, 0x16 /* 0x16d0 */ +/* USB vendor ID for the device, low byte first. If you have registered your + * own Vendor ID, define it here. Otherwise you may use one of obdev's free + * shared VID/PID pairs. Be sure to read USB-IDs-for-free.txt for rules! + * *** IMPORTANT NOTE *** + * This template uses obdev's shared VID/PID pair for Vendor Class devices + * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand + * the implications! + */ +#define USB_CFG_DEVICE_ID 0xFA, 0x09 /* 0x09FA - microjelly */ +/* This is the ID of the product, low byte first. It is interpreted in the + * scope of the vendor ID. If you have registered your own VID with usb.org + * or if you have licensed a PID from somebody else, define it here. Otherwise + * you may use one of obdev's free shared VID/PID pairs. See the file + * USB-IDs-for-free.txt for details! + * *** IMPORTANT NOTE *** + * This template uses obdev's shared VID/PID pair for Vendor Class devices + * with libusb: 0x16c0/0x5dc. Use this VID/PID pair ONLY if you understand + * the implications! + */ +#define USB_CFG_DEVICE_VERSION 0x01, 0x01 +/* Version number of the device: Minor number first, then major number. + */ +#define USB_CFG_VENDOR_NAME 'm', 'i', 'c', 'r', 'o', 'j', 'e', 'l', 'l', 'y', '.', 'c', 'o', 'm' +#define USB_CFG_VENDOR_NAME_LEN 14 +/* These two values define the vendor name returned by the USB device. The name + * must be given as a list of characters under single quotes. The characters + * are interpreted as Unicode (UTF-16) entities. + * If you don't want a vendor name string, undefine these macros. + * ALWAYS define a vendor name containing your Internet domain name if you use + * obdev's free shared VID/PID pair. See the file USB-IDs-for-free.txt for + * details. + */ +#define USB_CFG_DEVICE_NAME 'B','E','E','O','N',' ','-',' ','C','L','A','S','S','I','C' +#define USB_CFG_DEVICE_NAME_LEN 15 +/* Same as above for the device name. If you don't want a device name, undefine + * the macros. See the file USB-IDs-for-free.txt before you assign a name if + * you use a shared VID/PID. + */ + +#ifndef USB_CFG_SERIAL_NUMBER +#define USB_CFG_SERIAL_NUMBER 'B','E','E','#','-','#','#','-','#','#','#','#','#','#','#' +#endif + +#define USB_CFG_SERIAL_NUMBER_LEN 15 +/* Same as above for the serial number. If you don't want a serial number, + * undefine the macros. + * It may be useful to provide the serial number through other means than at + * compile time. See the section about descriptor properties below for how + * to fine tune control over USB descriptors such as the string descriptor + * for the serial number. + */ +#define USB_CFG_DEVICE_CLASS 0 +#define USB_CFG_DEVICE_SUBCLASS 0 +/* See USB specification if you want to conform to an existing device class. + * Class 0xff is "vendor specific". + */ +#define USB_CFG_INTERFACE_CLASS 3 +#define USB_CFG_INTERFACE_SUBCLASS 0 +#define USB_CFG_INTERFACE_PROTOCOL 0 +/* See USB specification if you want to conform to an existing device class or + * protocol. The following classes must be set at interface level: + * HID class is 3, no subclass and protocol required (but may be useful!) + * CDC class is 2, use subclass 2 and protocol 1 for ACM + */ +#define USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH 128 +/* Define this to the length of the HID report descriptor, if you implement + * an HID device. Otherwise don't define it or define it to 0. + * If you use this define, you must add a PROGMEM character array named + * "usbHidReportDescriptor" to your code which contains the report descriptor. + * Don't forget to keep the array and this define in sync! + */ + +/* #define USB_PUBLIC static */ +/* Use the define above if you #include usbdrv.c instead of linking against it. + * This technique saves a couple of bytes in flash memory. + */ + +/* ------------------- Fine Control over USB Descriptors ------------------- */ +/* If you don't want to use the driver's default USB descriptors, you can + * provide our own. These can be provided as (1) fixed length static data in + * flash memory, (2) fixed length static data in RAM or (3) dynamically at + * runtime in the function usbFunctionDescriptor(). See usbdrv.h for more + * information about this function. + * Descriptor handling is configured through the descriptor's properties. If + * no properties are defined or if they are 0, the default descriptor is used. + * Possible properties are: + * + USB_PROP_IS_DYNAMIC: The data for the descriptor should be fetched + * at runtime via usbFunctionDescriptor(). If the usbMsgPtr mechanism is + * used, the data is in FLASH by default. Add property USB_PROP_IS_RAM if + * you want RAM pointers. + * + USB_PROP_IS_RAM: The data returned by usbFunctionDescriptor() or found + * in static memory is in RAM, not in flash memory. + * + USB_PROP_LENGTH(len): If the data is in static memory (RAM or flash), + * the driver must know the descriptor's length. The descriptor itself is + * found at the address of a well known identifier (see below). + * List of static descriptor names (must be declared PROGMEM if in flash): + * char usbDescriptorDevice[]; + * char usbDescriptorConfiguration[]; + * char usbDescriptorHidReport[]; + * char usbDescriptorString0[]; + * int usbDescriptorStringVendor[]; + * int usbDescriptorStringDevice[]; + * int usbDescriptorStringSerialNumber[]; + * Other descriptors can't be provided statically, they must be provided + * dynamically at runtime. + * + * Descriptor properties are or-ed or added together, e.g.: + * #define USB_CFG_DESCR_PROPS_DEVICE (USB_PROP_IS_RAM | USB_PROP_LENGTH(18)) + * + * The following descriptors are defined: + * USB_CFG_DESCR_PROPS_DEVICE + * USB_CFG_DESCR_PROPS_CONFIGURATION + * USB_CFG_DESCR_PROPS_STRINGS + * USB_CFG_DESCR_PROPS_STRING_0 + * USB_CFG_DESCR_PROPS_STRING_VENDOR + * USB_CFG_DESCR_PROPS_STRING_PRODUCT + * USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER + * USB_CFG_DESCR_PROPS_HID + * USB_CFG_DESCR_PROPS_HID_REPORT + * USB_CFG_DESCR_PROPS_UNKNOWN (for all descriptors not handled by the driver) + * + * Note about string descriptors: String descriptors are not just strings, they + * are Unicode strings prefixed with a 2 byte header. Example: + * int serialNumberDescriptor[] = { + * USB_STRING_DESCRIPTOR_HEADER(6), + * 'S', 'e', 'r', 'i', 'a', 'l' + * }; + */ + +#define USB_CFG_DESCR_PROPS_DEVICE 0 +#define USB_CFG_DESCR_PROPS_CONFIGURATION 0 +#define USB_CFG_DESCR_PROPS_STRINGS 0 +#define USB_CFG_DESCR_PROPS_STRING_0 0 +#define USB_CFG_DESCR_PROPS_STRING_VENDOR 0 +#define USB_CFG_DESCR_PROPS_STRING_PRODUCT 0 +#define USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER 0 +#define USB_CFG_DESCR_PROPS_HID 0 +#define USB_CFG_DESCR_PROPS_HID_REPORT 0 +#define USB_CFG_DESCR_PROPS_UNKNOWN 0 + + +#define usbMsgPtr_t unsigned short +/* If usbMsgPtr_t is not defined, it defaults to 'uchar *'. We define it to + * a scalar type here because gcc generates slightly shorter code for scalar + * arithmetics than for pointer arithmetics. Remove this define for backward + * type compatibility or define it to an 8 bit type if you use data in RAM only + * and all RAM is below 256 bytes (tiny memory model in IAR CC). + */ + +/* ----------------------- Optional MCU Description ------------------------ */ + +/* The following configurations have working defaults in usbdrv.h. You + * usually don't need to set them explicitly. Only if you want to run + * the driver on a device which is not yet supported or with a compiler + * which is not fully supported (such as IAR C) or if you use a differnt + * interrupt than INT0, you may have to define some of these. + */ +/* #define USB_INTR_CFG MCUCR */ +/* #define USB_INTR_CFG_SET ((1 << ISC00) | (1 << ISC01)) */ +/* #define USB_INTR_CFG_CLR 0 */ +/* #define USB_INTR_ENABLE GIMSK */ +/* #define USB_INTR_ENABLE_BIT INT0 */ +/* #define USB_INTR_PENDING GIFR */ +/* #define USB_INTR_PENDING_BIT INTF0 */ +/* #define USB_INTR_VECTOR INT0_vect */ + +#define USB_INTR_CFG PCMSK +#define USB_INTR_CFG_SET (1 << USB_CFG_DPLUS_BIT) +#define USB_INTR_CFG_CLR 0 +#define USB_INTR_ENABLE GIMSK +#define USB_INTR_ENABLE_BIT PCIE +#define USB_INTR_PENDING GIFR +#define USB_INTR_PENDING_BIT PCIF +#define USB_INTR_VECTOR PCINT0_vect + +#endif /* __usbconfig_h_included__ */ diff --git a/classic/fw/usbdrv/Changelog.txt b/classic/fw/usbdrv/Changelog.txt new file mode 100644 index 0000000..79b5215 --- /dev/null +++ b/classic/fw/usbdrv/Changelog.txt @@ -0,0 +1,329 @@ +This file documents changes in the firmware-only USB driver for atmel's AVR +microcontrollers. New entries are always appended to the end of the file. +Scroll down to the bottom to see the most recent changes. + +2005-04-01: + - Implemented endpoint 1 as interrupt-in endpoint. + - Moved all configuration options to usbconfig.h which is not part of the + driver. + - Changed interface for usbVendorSetup(). + - Fixed compatibility with ATMega8 device. + - Various minor optimizations. + +2005-04-11: + - Changed interface to application: Use usbFunctionSetup(), usbFunctionRead() + and usbFunctionWrite() now. Added configuration options to choose which + of these functions to compile in. + - Assembler module delivers receive data non-inverted now. + - Made register and bit names compatible with more AVR devices. + +2005-05-03: + - Allow address of usbRxBuf on any memory page as long as the buffer does + not cross 256 byte page boundaries. + - Better device compatibility: works with Mega88 now. + - Code optimization in debugging module. + - Documentation updates. + +2006-01-02: + - Added (free) default Vendor- and Product-IDs bought from voti.nl. + - Added USBID-License.txt file which defines the rules for using the free + shared VID/PID pair. + - Added Readme.txt to the usbdrv directory which clarifies administrative + issues. + +2006-01-25: + - Added "configured state" to become more standards compliant. + - Added "HALT" state for interrupt endpoint. + - Driver passes the "USB Command Verifier" test from usb.org now. + - Made "serial number" a configuration option. + - Minor optimizations, we now recommend compiler option "-Os" for best + results. + - Added a version number to usbdrv.h + +2006-02-03: + - New configuration variable USB_BUFFER_SECTION for the memory section where + the USB rx buffer will go. This defaults to ".bss" if not defined. Since + this buffer MUST NOT cross 256 byte pages (not even touch a page at the + end), the user may want to pass a linker option similar to + "-Wl,--section-start=.mybuffer=0x800060". + - Provide structure for usbRequest_t. + - New defines for USB constants. + - Prepared for HID implementations. + - Increased data size limit for interrupt transfers to 8 bytes. + - New macro usbInterruptIsReady() to query interrupt buffer state. + +2006-02-18: + - Ensure that the data token which is sent as an ack to an OUT transfer is + always zero sized. This fixes a bug where the host reports an error after + sending an out transfer to the device, although all data arrived at the + device. + - Updated docs in usbdrv.h to reflect changed API in usbFunctionWrite(). + +* Release 2006-02-20 + + - Give a compiler warning when compiling with debugging turned on. + - Added Oleg Semyonov's changes for IAR-cc compatibility. + - Added new (optional) functions usbDeviceConnect() and usbDeviceDisconnect() + (also thanks to Oleg!). + - Rearranged tests in usbPoll() to save a couple of instructions in the most + likely case that no actions are pending. + - We need a delay between the SET ADDRESS request until the new address + becomes active. This delay was handled in usbPoll() until now. Since the + spec says that the delay must not exceed 2ms, previous versions required + aggressive polling during the enumeration phase. We have now moved the + handling of the delay into the interrupt routine. + - We must not reply with NAK to a SETUP transaction. We can only achieve this + by making sure that the rx buffer is empty when SETUP tokens are expected. + We therefore don't pass zero sized data packets from the status phase of + a transfer to usbPoll(). This change MAY cause troubles if you rely on + receiving a less than 8 bytes long packet in usbFunctionWrite() to + identify the end of a transfer. usbFunctionWrite() will NEVER be called + with a zero length. + +* Release 2006-03-14 + + - Improved IAR C support: tiny memory model, more devices + - Added template usbconfig.h file under the name usbconfig-prototype.h + +* Release 2006-03-26 + + - Added provision for one more interrupt-in endpoint (endpoint 3). + - Added provision for one interrupt-out endpoint (endpoint 1). + - Added flowcontrol macros for USB. + - Added provision for custom configuration descriptor. + - Allow ANY two port bits for D+ and D-. + - Merged (optional) receive endpoint number into global usbRxToken variable. + - Use USB_CFG_IOPORTNAME instead of USB_CFG_IOPORT. We now construct the + variable name from the single port letter instead of computing the address + of related ports from the output-port address. + +* Release 2006-06-26 + + - Updated documentation in usbdrv.h and usbconfig-prototype.h to reflect the + new features. + - Removed "#warning" directives because IAR does not understand them. Use + unused static variables instead to generate a warning. + - Do not include when compiling with IAR. + - Introduced USB_CFG_DESCR_PROPS_* in usbconfig.h to configure how each + USB descriptor should be handled. It is now possible to provide descriptor + data in Flash, RAM or dynamically at runtime. + - STALL is now a status in usbTxLen* instead of a message. We can now conform + to the spec and leave the stall status pending until it is cleared. + - Made usbTxPacketCnt1 and usbTxPacketCnt3 public. This allows the + application code to reset data toggling on interrupt pipes. + +* Release 2006-07-18 + + - Added an #if !defined __ASSEMBLER__ to the warning in usbdrv.h. This fixes + an assembler error. + - usbDeviceDisconnect() takes pull-up resistor to high impedance now. + +* Release 2007-02-01 + + - Merged in some code size improvements from usbtiny (thanks to Dick + Streefland for these optimizations!) + - Special alignment requirement for usbRxBuf not required any more. Thanks + again to Dick Streefland for this hint! + - Reverted to "#warning" instead of unused static variables -- new versions + of IAR CC should handle this directive. + - Changed Open Source license to GNU GPL v2 in order to make linking against + other free libraries easier. We no longer require publication of the + circuit diagrams, but we STRONGLY encourage it. If you improve the driver + itself, PLEASE grant us a royalty free license to your changes for our + commercial license. + +* Release 2007-03-29 + + - New configuration option "USB_PUBLIC" in usbconfig.h. + - Set USB version number to 1.10 instead of 1.01. + - Code used USB_CFG_DESCR_PROPS_STRING_DEVICE and + USB_CFG_DESCR_PROPS_STRING_PRODUCT inconsistently. Changed all occurrences + to USB_CFG_DESCR_PROPS_STRING_PRODUCT. + - New assembler module for 16.5 MHz RC oscillator clock with PLL in receiver + code. + - New assembler module for 16 MHz crystal. + - usbdrvasm.S contains common code only, clock-specific parts have been moved + to usbdrvasm12.S, usbdrvasm16.S and usbdrvasm165.S respectively. + +* Release 2007-06-25 + + - 16 MHz module: Do SE0 check in stuffed bits as well. + +* Release 2007-07-07 + + - Define hi8(x) for IAR compiler to limit result to 8 bits. This is necessary + for negative values. + - Added 15 MHz module contributed by V. Bosch. + - Interrupt vector name can now be configured. This is useful if somebody + wants to use a different hardware interrupt than INT0. + +* Release 2007-08-07 + + - Moved handleIn3 routine in usbdrvasm16.S so that relative jump range is + not exceeded. + - More config options: USB_RX_USER_HOOK(), USB_INITIAL_DATATOKEN, + USB_COUNT_SOF + - USB_INTR_PENDING can now be a memory address, not just I/O + +* Release 2007-09-19 + + - Split out common parts of assembler modules into separate include file + - Made endpoint numbers configurable so that given interface definitions + can be matched. See USB_CFG_EP3_NUMBER in usbconfig-prototype.h. + - Store endpoint number for interrupt/bulk-out so that usbFunctionWriteOut() + can handle any number of endpoints. + - Define usbDeviceConnect() and usbDeviceDisconnect() even if no + USB_CFG_PULLUP_IOPORTNAME is defined. Directly set D+ and D- to 0 in this + case. + +* Release 2007-12-01 + + - Optimize usbDeviceConnect() and usbDeviceDisconnect() for less code size + when USB_CFG_PULLUP_IOPORTNAME is not defined. + +* Release 2007-12-13 + + - Renamed all include-only assembler modules from *.S to *.inc so that + people don't add them to their project sources. + - Distribute leap bits in tx loop more evenly for 16 MHz module. + - Use "macro" and "endm" instead of ".macro" and ".endm" for IAR + - Avoid compiler warnings for constant expr range by casting some values in + USB descriptors. + +* Release 2008-01-21 + + - Fixed bug in 15 and 16 MHz module where the new address set with + SET_ADDRESS was already accepted at the next NAK or ACK we send, not at + the next data packet we send. This caused problems when the host polled + too fast. Thanks to Alexander Neumann for his help and patience debugging + this issue! + +* Release 2008-02-05 + + - Fixed bug in 16.5 MHz module where a register was used in the interrupt + handler before it was pushed. This bug was introduced with version + 2007-09-19 when common parts were moved to a separate file. + - Optimized CRC routine (thanks to Reimar Doeffinger). + +* Release 2008-02-16 + + - Removed outdated IAR compatibility stuff (code sections). + - Added hook macros for USB_RESET_HOOK() and USB_SET_ADDRESS_HOOK(). + - Added optional routine usbMeasureFrameLength() for calibration of the + internal RC oscillator. + +* Release 2008-02-28 + + - USB_INITIAL_DATATOKEN defaults to USBPID_DATA1 now, which means that we + start with sending USBPID_DATA0. + - Changed defaults in usbconfig-prototype.h + - Added free USB VID/PID pair for MIDI class devices + - Restructured AVR-USB as separate package, not part of PowerSwitch any more. + +* Release 2008-04-18 + + - Restructured usbdrv.c so that it is easier to read and understand. + - Better code optimization with gcc 4. + - If a second interrupt in endpoint is enabled, also add it to config + descriptor. + - Added config option for long transfers (above 254 bytes), see + USB_CFG_LONG_TRANSFERS in usbconfig.h. + - Added 20 MHz module contributed by Jeroen Benschop. + +* Release 2008-05-13 + + - Fixed bug in libs-host/hiddata.c function usbhidGetReport(): length + was not incremented, pointer to length was incremented instead. + - Added code to command line tool(s) which claims an interface. This code + is disabled by default, but may be necessary on newer Linux kernels. + - Added usbconfig.h option "USB_CFG_CHECK_DATA_TOGGLING". + - New header "usbportability.h" prepares ports to other development + environments. + - Long transfers (above 254 bytes) did not work when usbFunctionRead() was + used to supply the data. Fixed this bug. [Thanks to Alexander Neumann!] + - In hiddata.c (example code for sending/receiving data over HID), use + USB_RECIP_DEVICE instead of USB_RECIP_INTERFACE for control transfers so + that we need not claim the interface. + - in usbPoll() loop 20 times polling for RESET state instead of 10 times. + This accounts for the higher clock rates we now support. + - Added a module for 12.8 MHz RC oscillator with PLL in receiver loop. + - Added hook to SOF code so that oscillator can be tuned to USB frame clock. + - Added timeout to waitForJ loop. Helps preventing unexpected hangs. + - Added example code for oscillator tuning to libs-device (thanks to + Henrik Haftmann for the idea to this routine). + - Implemented option USB_CFG_SUPPRESS_INTR_CODE. + +* Release 2008-10-22 + + - Fixed libs-device/osctune.h: OSCCAL is memory address on ATMega88 and + similar, not offset of 0x20 needs to be added. + - Allow distribution under GPLv3 for those who have to link against other + code distributed under GPLv3. + +* Release 2008-11-26 + + - Removed libusb-win32 dependency for hid-data example in Makefile.windows. + It was never required and confused many people. + - Added extern uchar usbRxToken to usbdrv.h. + - Integrated a module with CRC checks at 18 MHz by Lukas Schrittwieser. + +* Release 2009-03-23 + + - Hid-mouse example used settings from hid-data example, fixed that. + - Renamed project to V-USB due to a trademark issue with Atmel(r). + - Changed CommercialLicense.txt and USBID-License.txt to make the + background of USB ID registration clearer. + +* Release 2009-04-15 + + - Changed CommercialLicense.txt to reflect the new range of PIDs from + Jason Kotzin. + - Removed USBID-License.txt in favor of USB-IDs-for-free.txt and + USB-ID-FAQ.txt + - Fixed a bug in the 12.8 MHz module: End Of Packet decection was made in + the center between bit 0 and 1 of each byte. This is where the data lines + are expected to change and the sampled data may therefore be nonsense. + We therefore check EOP ONLY if bits 0 AND 1 have both been read as 0 on D-. + - Fixed a bitstuffing problem in the 16 MHz module: If bit 6 was stuffed, + the unstuffing code in the receiver routine was 1 cycle too long. If + multiple bytes had the unstuffing in bit 6, the error summed up until the + receiver was out of sync. + - Included option for faster CRC routine. + Thanks to Slawomir Fras (BoskiDialer) for this code! + - Updated bits in Configuration Descriptor's bmAttributes according to + USB 1.1 (in particular bit 7, it is a must-be-set bit now). + +* Release 2009-08-22 + + - Moved first DBG1() after odDebugInit() in all examples. + - Use vector INT0_vect instead of SIG_INTERRUPT0 if defined. This makes + V-USB compatible with the new "p" suffix devices (e.g. ATMega328p). + - USB_CFG_CLOCK_KHZ setting is now required in usbconfig.h (no default any + more). + - New option USB_CFG_DRIVER_FLASH_PAGE allows boot loaders on devices with + more than 64 kB flash. + - Built-in configuration descriptor allows custom definition for second + endpoint now. + +* Release 2010-07-15 + + - Fixed bug in usbDriverSetup() which prevented descriptor sizes above 255 + bytes. + - Avoid a compiler warning for unused parameter in usbHandleResetHook() when + compiler option -Wextra is enabled. + - Fixed wrong hex value for some IDs in USB-IDs-for-free.txt. + - Keep a define for USBATTR_BUSPOWER, although the flag does not exist + in USB 1.1 any more. Set it to 0. This is for backward compatibility. + +* Release 2012-01-09 + + - Define a separate (defined) type for usbMsgPtr so that projects using a + tiny memory model can define it to an 8 bit type in usbconfig.h. This + change also saves a couple of bytes when using a scalar 16 bit type. + - Inserted "const" keyword for all PROGMEM declarations because new GCC + requires it. + - Fixed problem with dependence of usbportability.h on usbconfig.h. This + problem occurred with IAR CC only. + - Prepared repository for github.com. + +* Release 2012-12-06 \ No newline at end of file diff --git a/classic/fw/usbdrv/CommercialLicense.txt b/classic/fw/usbdrv/CommercialLicense.txt new file mode 100644 index 0000000..de1a2b0 --- /dev/null +++ b/classic/fw/usbdrv/CommercialLicense.txt @@ -0,0 +1,166 @@ +V-USB Driver Software License Agreement +Version 2012-07-09 + +THIS LICENSE AGREEMENT GRANTS YOU CERTAIN RIGHTS IN A SOFTWARE. YOU CAN +ENTER INTO THIS AGREEMENT AND ACQUIRE THE RIGHTS OUTLINED BELOW BY PAYING +THE AMOUNT ACCORDING TO SECTION 4 ("PAYMENT") TO OBJECTIVE DEVELOPMENT. + + +1 DEFINITIONS + +1.1 "OBJECTIVE DEVELOPMENT" shall mean OBJECTIVE DEVELOPMENT Software GmbH, +Grosse Schiffgasse 1A/7, 1020 Wien, AUSTRIA. + +1.2 "You" shall mean the Licensee. + +1.3 "V-USB" shall mean all files included in the package distributed under +the name "vusb" by OBJECTIVE DEVELOPMENT (http://www.obdev.at/vusb/) +unless otherwise noted. This includes the firmware-only USB device +implementation for Atmel AVR microcontrollers, some simple device examples +and host side software examples and libraries. + + +2 LICENSE GRANTS + +2.1 Source Code. OBJECTIVE DEVELOPMENT shall furnish you with the source +code of V-USB. + +2.2 Distribution and Use. OBJECTIVE DEVELOPMENT grants you the +non-exclusive right to use, copy and distribute V-USB with your hardware +product(s), restricted by the limitations in section 3 below. + +2.3 Modifications. OBJECTIVE DEVELOPMENT grants you the right to modify +the source code and your copy of V-USB according to your needs. + +2.4 USB IDs. OBJECTIVE DEVELOPMENT furnishes you with one or two USB +Product ID(s), sent to you in e-mail. These Product IDs are reserved +exclusively for you. OBJECTIVE DEVELOPMENT has obtained USB Product ID +ranges under the Vendor ID 5824 from Wouter van Ooijen (Van Ooijen +Technische Informatica, www.voti.nl) and under the Vendor ID 8352 from +Jason Kotzin (now flirc.tv, Inc.). Both owners of the Vendor IDs have +obtained these IDs from the USB Implementers Forum, Inc. (www.usb.org). +OBJECTIVE DEVELOPMENT disclaims all liability which might arise from the +assignment of USB IDs. + +2.5 USB Certification. Although not part of this agreement, we want to make +it clear that you cannot become USB certified when you use V-USB or a USB +Product ID assigned by OBJECTIVE DEVELOPMENT. AVR microcontrollers don't +meet the electrical specifications required by the USB specification and +the USB Implementers Forum certifies only members who bought a Vendor ID of +their own. + + +3 LICENSE RESTRICTIONS + +3.1 Number of Units. Only one of the following three definitions is +applicable. Which one is determined by the amount you pay to OBJECTIVE +DEVELOPMENT, see section 4 ("Payment") below. + +Hobby License: You may use V-USB according to section 2 above in no more +than 5 hardware units. These units must not be sold for profit. + +Entry Level License: You may use V-USB according to section 2 above in no +more than 150 hardware units. + +Professional License: You may use V-USB according to section 2 above in +any number of hardware units, except for large scale production ("unlimited +fair use"). Quantities below 10,000 units are not considered large scale +production. If your reach quantities which are obviously large scale +production, you must pay a license fee of 0.10 EUR per unit for all units +above 10,000. + +3.2 Rental. You may not rent, lease, or lend V-USB or otherwise encumber +any copy of V-USB, or any of the rights granted herein. + +3.3 Transfer. You may not transfer your rights under this Agreement to +another party without OBJECTIVE DEVELOPMENT's prior written consent. If +such consent is obtained, you may permanently transfer this License to +another party. The recipient of such transfer must agree to all terms and +conditions of this Agreement. + +3.4 Reservation of Rights. OBJECTIVE DEVELOPMENT retains all rights not +expressly granted. + +3.5 Non-Exclusive Rights. Your license rights under this Agreement are +non-exclusive. + +3.6 Third Party Rights. This Agreement cannot grant you rights controlled +by third parties. In particular, you are not allowed to use the USB logo or +other trademarks owned by the USB Implementers Forum, Inc. without their +consent. Since such consent depends on USB certification, it should be +noted that V-USB will not pass certification because it does not +implement checksum verification and the microcontroller ports do not meet +the electrical specifications. + + +4 PAYMENT + +The payment amount depends on the variation of this agreement (according to +section 3.1) into which you want to enter. Concrete prices are listed on +OBJECTIVE DEVELOPMENT's web site, usually at +http://www.obdev.at/vusb/license.html. You agree to pay the amount listed +there to OBJECTIVE DEVELOPMENT or OBJECTIVE DEVELOPMENT's payment processor +or reseller. + + +5 COPYRIGHT AND OWNERSHIP + +V-USB is protected by copyright laws and international copyright +treaties, as well as other intellectual property laws and treaties. V-USB +is licensed, not sold. + + +6 TERM AND TERMINATION + +6.1 Term. This Agreement shall continue indefinitely. However, OBJECTIVE +DEVELOPMENT may terminate this Agreement and revoke the granted license and +USB-IDs if you fail to comply with any of its terms and conditions. + +6.2 Survival of Terms. All provisions regarding secrecy, confidentiality +and limitation of liability shall survive termination of this agreement. + + +7 DISCLAIMER OF WARRANTY AND LIABILITY + +LIMITED WARRANTY. V-USB IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +KIND. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, OBJECTIVE +DEVELOPMENT AND ITS SUPPLIERS HEREBY DISCLAIM ALL WARRANTIES, EITHER +EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND +NON-INFRINGEMENT, WITH REGARD TO V-USB, AND THE PROVISION OF OR FAILURE +TO PROVIDE SUPPORT SERVICES. THIS LIMITED WARRANTY GIVES YOU SPECIFIC LEGAL +RIGHTS. YOU MAY HAVE OTHERS, WHICH VARY FROM STATE/JURISDICTION TO +STATE/JURISDICTION. + +LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, +IN NO EVENT SHALL OBJECTIVE DEVELOPMENT OR ITS SUPPLIERS BE LIABLE FOR ANY +SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER +(INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, +BUSINESS INTERRUPTION, LOSS OF BUSINESS INFORMATION, OR ANY OTHER PECUNIARY +LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE V-USB OR THE +PROVISION OF OR FAILURE TO PROVIDE SUPPORT SERVICES, EVEN IF OBJECTIVE +DEVELOPMENT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. IN ANY +CASE, OBJECTIVE DEVELOPMENT'S ENTIRE LIABILITY UNDER ANY PROVISION OF THIS +AGREEMENT SHALL BE LIMITED TO THE AMOUNT ACTUALLY PAID BY YOU FOR V-USB. + + +8 MISCELLANEOUS TERMS + +8.1 Marketing. OBJECTIVE DEVELOPMENT has the right to mention for marketing +purposes that you entered into this agreement. + +8.2 Entire Agreement. This document represents the entire agreement between +OBJECTIVE DEVELOPMENT and you. It may only be modified in writing signed by +an authorized representative of both, OBJECTIVE DEVELOPMENT and you. + +8.3 Severability. In case a provision of these terms and conditions should +be or become partly or entirely invalid, ineffective, or not executable, +the validity of all other provisions shall not be affected. + +8.4 Applicable Law. This agreement is governed by the laws of the Republic +of Austria. + +8.5 Responsible Courts. The responsible courts in Vienna/Austria will have +exclusive jurisdiction regarding all disputes in connection with this +agreement. + diff --git a/classic/fw/usbdrv/License.txt b/classic/fw/usbdrv/License.txt new file mode 100644 index 0000000..4460cfb --- /dev/null +++ b/classic/fw/usbdrv/License.txt @@ -0,0 +1,361 @@ +OBJECTIVE DEVELOPMENT GmbH's V-USB driver software is distributed under the +terms and conditions of the GNU GPL version 2 or the GNU GPL version 3. It is +your choice whether you apply the terms of version 2 or version 3. The full +text of GPLv2 is included below. In addition to the requirements in the GPL, +we STRONGLY ENCOURAGE you to do the following: + +(1) Publish your entire project on a web site and drop us a note with the URL. +Use the form at http://www.obdev.at/vusb/feedback.html for your submission. + +(2) Adhere to minimum publication standards. Please include AT LEAST: + - a circuit diagram in PDF, PNG or GIF format + - full source code for the host software + - a Readme.txt file in ASCII format which describes the purpose of the + project and what can be found in which directories and which files + - a reference to http://www.obdev.at/vusb/ + +(3) If you improve the driver firmware itself, please give us a free license +to your modifications for our commercial license offerings. + + + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. diff --git a/classic/fw/usbdrv/Readme.txt b/classic/fw/usbdrv/Readme.txt new file mode 100644 index 0000000..970dc66 --- /dev/null +++ b/classic/fw/usbdrv/Readme.txt @@ -0,0 +1,172 @@ +This is the Readme file to Objective Development's firmware-only USB driver +for Atmel AVR microcontrollers. For more information please visit +http://www.obdev.at/vusb/ + +This directory contains the USB firmware only. Copy it as-is to your own +project and add all .c and .S files to your project (these files are marked +with an asterisk in the list below). Then copy usbconfig-prototype.h as +usbconfig.h to your project and edit it according to your configuration. + + +TECHNICAL DOCUMENTATION +======================= +The technical documentation (API) for the firmware driver is contained in the +file "usbdrv.h". Please read all of it carefully! Configuration options are +documented in "usbconfig-prototype.h". + +The driver consists of the following files: + Readme.txt ............. The file you are currently reading. + Changelog.txt .......... Release notes for all versions of the driver. + usbdrv.h ............... Driver interface definitions and technical docs. +* usbdrv.c ............... High level language part of the driver. Link this + module to your code! +* usbdrvasm.S ............ Assembler part of the driver. This module is mostly + a stub and includes one of the usbdrvasm*.S files + depending on processor clock. Link this module to + your code! + usbdrvasm*.inc ......... Assembler routines for particular clock frequencies. + Included by usbdrvasm.S, don't link it directly! + asmcommon.inc .......... Common assembler routines. Included by + usbdrvasm*.inc, don't link it directly! + usbconfig-prototype.h .. Prototype for your own usbdrv.h file. +* oddebug.c .............. Debug functions. Only used when DEBUG_LEVEL is + defined to a value greater than 0. Link this module + to your code! + oddebug.h .............. Interface definitions of the debug module. + usbportability.h ....... Header with compiler-dependent stuff. + usbdrvasm.asm .......... Compatibility stub for IAR-C-compiler. Use this + module instead of usbdrvasm.S when you assembler + with IAR's tools. + License.txt ............ Open Source license for this driver. + CommercialLicense.txt .. Optional commercial license for this driver. + USB-ID-FAQ.txt ......... General infos about USB Product- and Vendor-IDs. + USB-IDs-for-free.txt ... List and terms of use for free shared PIDs. + +(*) ... These files should be linked to your project. + + +CPU CORE CLOCK FREQUENCY +======================== +We supply assembler modules for clock frequencies of 12 MHz, 12.8 MHz, 15 MHz, +16 MHz, 16.5 MHz 18 MHz and 20 MHz. Other clock rates are not supported. The +actual clock rate must be configured in usbconfig.h. + +12 MHz Clock +This is the traditional clock rate of V-USB because it's the lowest clock +rate where the timing constraints of the USB spec can be met. + +15 MHz Clock +Similar to 12 MHz, but some NOPs inserted. On the other hand, the higher clock +rate allows for some loops which make the resulting code size somewhat smaller +than the 12 MHz version. + +16 MHz Clock +This clock rate has been added for users of the Arduino board and other +ready-made boards which come with a fixed 16 MHz crystal. It's also an option +if you need the slightly higher clock rate for performance reasons. Since +16 MHz is not divisible by the USB low speed bit clock of 1.5 MHz, the code +is somewhat tricky and has to insert a leap cycle every third byte. + +12.8 MHz and 16.5 MHz Clock +The assembler modules for these clock rates differ from the other modules +because they have been built for an RC oscillator with only 1% precision. The +receiver code inserts leap cycles to compensate for clock deviations. 1% is +also the precision which can be achieved by calibrating the internal RC +oscillator of the AVR. Please note that only AVRs with internal 64 MHz PLL +oscillator can reach 16.5 MHz with the RC oscillator. This includes the very +popular ATTiny25, ATTiny45, ATTiny85 series as well as the ATTiny26. Almost +all AVRs can reach 12.8 MHz, although this is outside the specified range. + +See the EasyLogger example at http://www.obdev.at/vusb/easylogger.html for +code which calibrates the RC oscillator based on the USB frame clock. + +18 MHz Clock +This module is closer to the USB specification because it performs an on the +fly CRC check for incoming packets. Packets with invalid checksum are +discarded as required by the spec. If you also implement checks for data +PID toggling on application level (see option USB_CFG_CHECK_DATA_TOGGLING +in usbconfig.h for more info), this ensures data integrity. Due to the CRC +tables and alignment requirements, this code is bigger than modules for other +clock rates. To activate this module, you must define USB_CFG_CHECK_CRC to 1 +and USB_CFG_CLOCK_KHZ to 18000 in usbconfig.h. + +20 MHz Clock +This module is for people who won't do it with less than the maximum. Since +20 MHz is not divisible by the USB low speed bit clock of 1.5 MHz, the code +uses similar tricks as the 16 MHz module to insert leap cycles. + + +USB IDENTIFIERS +=============== +Every USB device needs a vendor- and a product-identifier (VID and PID). VIDs +are obtained from usb.org for a price of 1,500 USD. Once you have a VID, you +can assign PIDs at will. + +Since an entry level cost of 1,500 USD is too high for most small companies +and hobbyists, we provide some VID/PID pairs for free. See the file +USB-IDs-for-free.txt for details. + +Objective Development also has some license offerings which include product +IDs. See http://www.obdev.at/vusb/ for details. + + +DEVELOPMENT SYSTEM +================== +This driver has been developed and optimized for the GNU compiler version 3 +and 4. We recommend that you use the GNU compiler suite because it is freely +available. V-USB has also been ported to the IAR compiler and assembler. It +has been tested with IAR 4.10B/W32 and 4.12A/W32 on an ATmega8 with the +"small" and "tiny" memory model. Not every release is tested with IAR CC and +the driver may therefore fail to compile with IAR. Please note that gcc is +more efficient for usbdrv.c because this module has been deliberately +optimized for gcc. + +Gcc version 3 produces smaller code than version 4 due to new optimizing +capabilities which don't always improve things on 8 bit CPUs. The code size +generated by gcc 4 can be reduced with the compiler options +-fno-move-loop-invariants, -fno-tree-scev-cprop and +-fno-inline-small-functions in addition to -Os. On devices with more than +8k of flash memory, we also recommend the linker option --relax (written as +-Wl,--relax for gcc) to convert absolute calls into relative where possible. + +For more information about optimizing options see: + + http://www.tty1.net/blog/2008-04-29-avr-gcc-optimisations_en.html + +These optimizations are good for gcc 4.x. Version 3.x of gcc does not support +most of these options and produces good code anyway. + + +USING V-USB FOR FREE +==================== +The AVR firmware driver is published under the GNU General Public License +Version 2 (GPL2) and the GNU General Public License Version 3 (GPL3). It is +your choice whether you apply the terms of version 2 or version 3. + +If you decide for the free GPL2 or GPL3, we STRONGLY ENCOURAGE you to do the +following things IN ADDITION to the obligations from the GPL: + +(1) Publish your entire project on a web site and drop us a note with the URL. +Use the form at http://www.obdev.at/vusb/feedback.html for your submission. +If you don't have a web site, you can publish the project in obdev's +documentation wiki at +http://www.obdev.at/goto.php?t=vusb-wiki&p=hosted-projects. + +(2) Adhere to minimum publication standards. Please include AT LEAST: + - a circuit diagram in PDF, PNG or GIF format + - full source code for the host software + - a Readme.txt file in ASCII format which describes the purpose of the + project and what can be found in which directories and which files + - a reference to http://www.obdev.at/vusb/ + +(3) If you improve the driver firmware itself, please give us a free license +to your modifications for our commercial license offerings. + + +COMMERCIAL LICENSES FOR V-USB +============================= +If you don't want to publish your source code under the terms of the GPL, +you can simply pay money for V-USB. As an additional benefit you get +USB PIDs for free, reserved exclusively to you. See the file +"CommercialLicense.txt" for details. + diff --git a/classic/fw/usbdrv/USB-ID-FAQ.txt b/classic/fw/usbdrv/USB-ID-FAQ.txt new file mode 100644 index 0000000..a4a6bd6 --- /dev/null +++ b/classic/fw/usbdrv/USB-ID-FAQ.txt @@ -0,0 +1,149 @@ +Version 2012-07-09 + +========================== +WHY DO WE NEED THESE IDs? +========================== + +USB is more than a low level protocol for data transport. It also defines a +common set of requests which must be understood by all devices. And as part +of these common requests, the specification defines data structures, the +USB Descriptors, which are used to describe the properties of the device. + +From the perspective of an operating system, it is therefore possible to find +out basic properties of a device (such as e.g. the manufacturer and the name +of the device) without a device-specific driver. This is essential because +the operating system can choose a driver to load based on this information +(Plug-And-Play). + +Among the most important properties in the Device Descriptor are the USB +Vendor- and Product-ID. Both are 16 bit integers. The most simple form of +driver matching is based on these IDs. The driver announces the Vendor- and +Product-IDs of the devices it can handle and the operating system loads the +appropriate driver when the device is connected. + +It is obvious that this technique only works if the pair Vendor- plus +Product-ID is unique: Only devices which require the same driver can have the +same pair of IDs. + + +===================================================== +HOW DOES THE USB STANDARD ENSURE THAT IDs ARE UNIQUE? +===================================================== + +Since it is so important that USB IDs are unique, the USB Implementers Forum, +Inc. (usb.org) needs a way to enforce this legally. It is not forbidden by +law to build a device and assign it any random numbers as IDs. Usb.org +therefore needs an agreement to regulate the use of USB IDs. The agreement +binds only parties who agreed to it, of course. Everybody else is free to use +any numbers for their IDs. + +So how can usb.org ensure that every manufacturer of USB devices enters into +an agreement with them? They do it via trademark licensing. Usb.org has +registered the trademark "USB", all associated logos and related terms. If +you want to put an USB logo on your product or claim that it is USB +compliant, you must license these trademarks from usb.org. And this is where +you enter into an agreement. See the "USB-IF Trademark License Agreement and +Usage Guidelines for the USB-IF Logo" at +http://www.usb.org/developers/logo_license/. + +Licensing the USB trademarks requires that you buy a USB Vendor-ID from +usb.org (one-time fee of ca. 2,000 USD), that you become a member of usb.org +(yearly fee of ca. 4,000 USD) and that you meet all the technical +specifications from the USB spec. + +This means that most hobbyists and small companies will never be able to +become USB compliant, just because membership is so expensive. And you can't +be compliant with a driver based on V-USB anyway, because the AVR's port pins +don't meet the electrical specifications for USB. So, in principle, all +hobbyists and small companies are free to choose any random numbers for their +IDs. They have nothing to lose... + +There is one exception worth noting, though: If you use a sub-component which +implements USB, the vendor of the sub-components may guarantee USB +compliance. This might apply to some or all of FTDI's solutions. + + +======================================================================= +WHY SHOULD YOU OBTAIN USB IDs EVEN IF YOU DON'T LICENSE USB TRADEMARKS? +======================================================================= + +You have learned in the previous section that you are free to choose any +numbers for your IDs anyway. So why not do exactly this? There is still the +technical issue. If you choose IDs which are already in use by somebody else, +operating systems will load the wrong drivers and your device won't work. +Even if you choose IDs which are not currently in use, they may be in use in +the next version of the operating system or even after an automatic update. + +So what you need is a pair of Vendor- and Product-IDs for which you have the +guarantee that no USB compliant product uses them. This implies that no +operating system will ever ship with drivers responsible for these IDs. + + +============================================== +HOW DOES OBJECTIVE DEVELOPMENT HANDLE USB IDs? +============================================== + +Objective Development gives away pairs of USB-IDs with their V-USB licenses. +In order to ensure that these IDs are unique, Objective Development has an +agreement with the company/person who has bought the USB Vendor-ID from +usb.org. This agreement ensures that a range of USB Product-IDs is reserved +for assignment by Objective Development and that the owner of the Vendor-ID +won't give it to anybody else. + +This means that you have to trust three parties to ensure uniqueness of +your IDs: + + - Objective Development, that they don't give the same PID to more than + one person. + - The owner of the Vendor-ID that they don't assign PIDs from the range + assigned to Objective Development to anybody else. + - Usb.org that they don't assign the same Vendor-ID a second time. + + +================================== +WHO IS THE OWNER OF THE VENDOR-ID? +================================== + +Objective Development has obtained ranges of USB Product-IDs under two +Vendor-IDs: Under Vendor-ID 5824 from Wouter van Ooijen (Van Ooijen +Technische Informatica, www.voti.nl) and under Vendor-ID 8352 from Jason +Kotzin (now flirc.tv, Inc.). Both VID owners have received their Vendor-ID +directly from usb.org. + + +========================================================================= +CAN I USE USB-IDs FROM OBJECTIVE DEVELOPMENT WITH OTHER DRIVERS/HARDWARE? +========================================================================= + +The short answer is: Yes. All you get is a guarantee that the IDs are never +assigned to anybody else. What more do you need? + + +============================ +WHAT ABOUT SHARED ID PAIRS? +============================ + +Objective Development has reserved some PID/VID pairs for shared use. You +have no guarantee of uniqueness for them, except that no USB compliant device +uses them. In order to avoid technical problems, we must ensure that all +devices with the same pair of IDs use the same driver on kernel level. For +details, see the file USB-IDs-for-free.txt. + + +====================================================== +I HAVE HEARD THAT SUB-LICENSING OF USB-IDs IS ILLEGAL? +====================================================== + +A 16 bit integer number cannot be protected by copyright laws. It is not +sufficiently complex. And since none of the parties involved entered into the +USB-IF Trademark License Agreement, we are not bound by this agreement. So +there is no reason why it should be illegal to sub-license USB-IDs. + + +============================================= +WHO IS LIABLE IF THERE ARE INCOMPATIBILITIES? +============================================= + +Objective Development disclaims all liabilities which might arise from the +assignment of IDs. If you guarantee product features to your customers +without proper disclaimer, YOU are liable for that. diff --git a/classic/fw/usbdrv/USB-IDs-for-free.txt b/classic/fw/usbdrv/USB-IDs-for-free.txt new file mode 100644 index 0000000..d46517d --- /dev/null +++ b/classic/fw/usbdrv/USB-IDs-for-free.txt @@ -0,0 +1,154 @@ +Version 2009-08-22 + +=========================== +FREE USB-IDs FOR SHARED USE +=========================== + +Objective Development has reserved a set of USB Product-IDs for use according +to the guidelines outlined below. For more information about the concept of +USB IDs please see the file USB-ID-FAQ.txt. Objective Development guarantees +that the IDs listed below are not used by any USB compliant devices. + + +==================== +MECHANISM OF SHARING +==================== + +From a technical point of view, two different devices can share the same USB +Vendor- and Product-ID if they require the same driver on operating system +level. We make use of this fact by assigning separate IDs for various device +classes. On application layer, devices must be distinguished by their textual +name or serial number. We offer separate sets of IDs for discrimination by +textual name and for serial number. + +Examples for shared use of USB IDs are included with V-USB in the "examples" +subdirectory. + + +====================================== +IDs FOR DISCRIMINATION BY TEXTUAL NAME +====================================== + +If you use one of the IDs listed below, your device and host-side software +must conform to these rules: + +(1) The USB device MUST provide a textual representation of the manufacturer +and product identification. The manufacturer identification MUST be available +at least in USB language 0x0409 (English/US). + +(2) The textual manufacturer identification MUST contain either an Internet +domain name (e.g. "mycompany.com") registered and owned by you, or an e-mail +address under your control (e.g. "myname@gmx.net"). You can embed the domain +name or e-mail address in any string you like, e.g. "Objective Development +http://www.obdev.at/vusb/". + +(3) You are responsible for retaining ownership of the domain or e-mail +address for as long as any of your products are in use. + +(4) You may choose any string for the textual product identification, as long +as this string is unique within the scope of your textual manufacturer +identification. + +(5) Application side device look-up MUST be based on the textual manufacturer +and product identification in addition to VID/PID matching. The driver +matching MUST be a comparison of the entire strings, NOT a sub-string match. + +(6) For devices which implement a particular USB device class (e.g. HID), the +operating system's default class driver MUST be used. If an operating system +driver for Vendor Class devices is needed, this driver must be libusb or +libusb-win32 (see http://libusb.org/ and +http://libusb-win32.sourceforge.net/). + +Table if IDs for discrimination by textual name: + +PID dec (hex) | VID dec (hex) | Description of use +==============+===============+============================================ +1500 (0x05dc) | 5824 (0x16c0) | For Vendor Class devices with libusb +--------------+---------------+-------------------------------------------- +1503 (0x05df) | 5824 (0x16c0) | For generic HID class devices (which are + | | NOT mice, keyboards or joysticks) +--------------+---------------+-------------------------------------------- +1505 (0x05e1) | 5824 (0x16c0) | For CDC-ACM class devices (modems) +--------------+---------------+-------------------------------------------- +1508 (0x05e4) | 5824 (0x16c0) | For MIDI class devices +--------------+---------------+-------------------------------------------- + +Note that Windows caches the textual product- and vendor-description for +mice, keyboards and joysticks. Name-bsed discrimination is therefore not +recommended for these device classes. + + +======================================= +IDs FOR DISCRIMINATION BY SERIAL NUMBER +======================================= + +If you use one of the IDs listed below, your device and host-side software +must conform to these rules: + +(1) The USB device MUST provide a textual representation of the serial +number, unless ONLY the operating system's default class driver is used. +The serial number string MUST be available at least in USB language 0x0409 +(English/US). + +(2) The serial number MUST start with either an Internet domain name (e.g. +"mycompany.com") registered and owned by you, or an e-mail address under your +control (e.g. "myname@gmx.net"), both terminated with a colon (":") character. +You MAY append any string you like for further discrimination of your devices. + +(3) You are responsible for retaining ownership of the domain or e-mail +address for as long as any of your products are in use. + +(5) Application side device look-up MUST be based on the serial number string +in addition to VID/PID matching. The matching must start at the first +character of the serial number string and include the colon character +terminating your domain or e-mail address. It MAY stop anywhere after that. + +(6) For devices which implement a particular USB device class (e.g. HID), the +operating system's default class driver MUST be used. If an operating system +driver for Vendor Class devices is needed, this driver must be libusb or +libusb-win32 (see http://libusb.org/ and +http://libusb-win32.sourceforge.net/). + +(7) If ONLY the operating system's default class driver is used, e.g. for +mice, keyboards, joysticks, CDC or MIDI devices and no discrimination by an +application is needed, the serial number may be omitted. + + +Table if IDs for discrimination by serial number string: + +PID dec (hex) | VID dec (hex) | Description of use +===============+===============+=========================================== +10200 (0x27d8) | 5824 (0x16c0) | For Vendor Class devices with libusb +---------------+---------------+------------------------------------------- +10201 (0x27d9) | 5824 (0x16c0) | For generic HID class devices (which are + | | NOT mice, keyboards or joysticks) +---------------+---------------+------------------------------------------- +10202 (0x27da) | 5824 (0x16c0) | For USB Mice +---------------+---------------+------------------------------------------- +10203 (0x27db) | 5824 (0x16c0) | For USB Keyboards +---------------+---------------+------------------------------------------- +10204 (0x27dc) | 5824 (0x16c0) | For USB Joysticks +---------------+---------------+------------------------------------------- +10205 (0x27dd) | 5824 (0x16c0) | For CDC-ACM class devices (modems) +---------------+---------------+------------------------------------------- +10206 (0x27de) | 5824 (0x16c0) | For MIDI class devices +---------------+---------------+------------------------------------------- + + +================= +ORIGIN OF USB-IDs +================= + +OBJECTIVE DEVELOPMENT Software GmbH has obtained all VID/PID pairs listed +here from Wouter van Ooijen (see www.voti.nl) for exclusive disposition. +Wouter van Ooijen has obtained the VID from the USB Implementers Forum, Inc. +(see www.usb.org). The VID is registered for the company name "Van Ooijen +Technische Informatica". + + +========== +DISCLAIMER +========== + +OBJECTIVE DEVELOPMENT Software GmbH disclaims all liability for any +problems which are caused by the shared use of these VID/PID pairs. diff --git a/classic/fw/usbdrv/asmcommon.inc b/classic/fw/usbdrv/asmcommon.inc new file mode 100644 index 0000000..d2a4f7c --- /dev/null +++ b/classic/fw/usbdrv/asmcommon.inc @@ -0,0 +1,187 @@ +/* Name: asmcommon.inc + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Christian Starkjohann + * Creation Date: 2007-11-05 + * Tabsize: 4 + * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +/* Do not link this file! Link usbdrvasm.S instead, which includes the + * appropriate implementation! + */ + +/* +General Description: +This file contains assembler code which is shared among the USB driver +implementations for different CPU cocks. Since the code must be inserted +in the middle of the module, it's split out into this file and #included. + +Jump destinations called from outside: + sofError: Called when no start sequence was found. + se0: Called when a package has been successfully received. + overflow: Called when receive buffer overflows. + doReturn: Called after sending data. + +Outside jump destinations used by this module: + waitForJ: Called to receive an already arriving packet. + sendAckAndReti: + sendNakAndReti: + sendCntAndReti: + usbSendAndReti: + +The following macros must be defined before this file is included: + .macro POP_STANDARD + .endm + .macro POP_RETI + .endm +*/ + +#define token x1 + +overflow: + ldi x2, 1< 0 + +#warning "Never compile production devices with debugging enabled" + +static void uartPutc(char c) +{ + while(!(ODDBG_USR & (1 << ODDBG_UDRE))); /* wait for data register empty */ + ODDBG_UDR = c; +} + +static uchar hexAscii(uchar h) +{ + h &= 0xf; + if(h >= 10) + h += 'a' - (uchar)10 - '0'; + h += '0'; + return h; +} + +static void printHex(uchar c) +{ + uartPutc(hexAscii(c >> 4)); + uartPutc(hexAscii(c)); +} + +void odDebug(uchar prefix, uchar *data, uchar len) +{ + printHex(prefix); + uartPutc(':'); + while(len--){ + uartPutc(' '); + printHex(*data++); + } + uartPutc('\r'); + uartPutc('\n'); +} + +#endif diff --git a/classic/fw/usbdrv/oddebug.h b/classic/fw/usbdrv/oddebug.h new file mode 100644 index 0000000..851f84d --- /dev/null +++ b/classic/fw/usbdrv/oddebug.h @@ -0,0 +1,122 @@ +/* Name: oddebug.h + * Project: AVR library + * Author: Christian Starkjohann + * Creation Date: 2005-01-16 + * Tabsize: 4 + * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +#ifndef __oddebug_h_included__ +#define __oddebug_h_included__ + +/* +General Description: +This module implements a function for debug logs on the serial line of the +AVR microcontroller. Debugging can be configured with the define +'DEBUG_LEVEL'. If this macro is not defined or defined to 0, all debugging +calls are no-ops. If it is 1, DBG1 logs will appear, but not DBG2. If it is +2, DBG1 and DBG2 logs will be printed. + +A debug log consists of a label ('prefix') to indicate which debug log created +the output and a memory block to dump in hex ('data' and 'len'). +*/ + + +#ifndef F_CPU +# define F_CPU 12000000 /* 12 MHz */ +#endif + +/* make sure we have the UART defines: */ +#include "usbportability.h" + +#ifndef uchar +# define uchar unsigned char +#endif + +#if DEBUG_LEVEL > 0 && !(defined TXEN || defined TXEN0) /* no UART in device */ +# warning "Debugging disabled because device has no UART" +# undef DEBUG_LEVEL +#endif + +#ifndef DEBUG_LEVEL +# define DEBUG_LEVEL 0 +#endif + +/* ------------------------------------------------------------------------- */ + +#if DEBUG_LEVEL > 0 +# define DBG1(prefix, data, len) odDebug(prefix, data, len) +#else +# define DBG1(prefix, data, len) +#endif + +#if DEBUG_LEVEL > 1 +# define DBG2(prefix, data, len) odDebug(prefix, data, len) +#else +# define DBG2(prefix, data, len) +#endif + +/* ------------------------------------------------------------------------- */ + +#if DEBUG_LEVEL > 0 +extern void odDebug(uchar prefix, uchar *data, uchar len); + +/* Try to find our control registers; ATMEL likes to rename these */ + +#if defined UBRR +# define ODDBG_UBRR UBRR +#elif defined UBRRL +# define ODDBG_UBRR UBRRL +#elif defined UBRR0 +# define ODDBG_UBRR UBRR0 +#elif defined UBRR0L +# define ODDBG_UBRR UBRR0L +#endif + +#if defined UCR +# define ODDBG_UCR UCR +#elif defined UCSRB +# define ODDBG_UCR UCSRB +#elif defined UCSR0B +# define ODDBG_UCR UCSR0B +#endif + +#if defined TXEN +# define ODDBG_TXEN TXEN +#else +# define ODDBG_TXEN TXEN0 +#endif + +#if defined USR +# define ODDBG_USR USR +#elif defined UCSRA +# define ODDBG_USR UCSRA +#elif defined UCSR0A +# define ODDBG_USR UCSR0A +#endif + +#if defined UDRE +# define ODDBG_UDRE UDRE +#else +# define ODDBG_UDRE UDRE0 +#endif + +#if defined UDR +# define ODDBG_UDR UDR +#elif defined UDR0 +# define ODDBG_UDR UDR0 +#endif + +static inline void odDebugInit(void) +{ + ODDBG_UCR |= (1<len & 0x10){ /* packet buffer was empty */ + txStatus->buffer[0] ^= USBPID_DATA0 ^ USBPID_DATA1; /* toggle token */ + }else{ + txStatus->len = USBPID_NAK; /* avoid sending outdated (overwritten) interrupt data */ + } + p = txStatus->buffer + 1; + i = len; + do{ /* if len == 0, we still copy 1 byte, but that's no problem */ + *p++ = *data++; + }while(--i > 0); /* loop control at the end is 2 bytes shorter than at beginning */ + usbCrc16Append(&txStatus->buffer[1], len); + txStatus->len = len + 4; /* len must be given including sync byte */ + DBG2(0x21 + (((int)txStatus >> 3) & 3), txStatus->buffer, len + 3); +} + +USB_PUBLIC void usbSetInterrupt(uchar *data, uchar len) +{ + usbGenericSetInterrupt(data, len, &usbTxStatus1); +} +#endif + +#if USB_CFG_HAVE_INTRIN_ENDPOINT3 +USB_PUBLIC void usbSetInterrupt3(uchar *data, uchar len) +{ + usbGenericSetInterrupt(data, len, &usbTxStatus3); +} +#endif +#endif /* USB_CFG_SUPPRESS_INTR_CODE */ + +/* ------------------ utilities for code following below ------------------- */ + +/* Use defines for the switch statement so that we can choose between an + * if()else if() and a switch/case based implementation. switch() is more + * efficient for a LARGE set of sequential choices, if() is better in all other + * cases. + */ +#if USB_CFG_USE_SWITCH_STATEMENT +# define SWITCH_START(cmd) switch(cmd){{ +# define SWITCH_CASE(value) }break; case (value):{ +# define SWITCH_CASE2(v1,v2) }break; case (v1): case(v2):{ +# define SWITCH_CASE3(v1,v2,v3) }break; case (v1): case(v2): case(v3):{ +# define SWITCH_DEFAULT }break; default:{ +# define SWITCH_END }} +#else +# define SWITCH_START(cmd) {uchar _cmd = cmd; if(0){ +# define SWITCH_CASE(value) }else if(_cmd == (value)){ +# define SWITCH_CASE2(v1,v2) }else if(_cmd == (v1) || _cmd == (v2)){ +# define SWITCH_CASE3(v1,v2,v3) }else if(_cmd == (v1) || _cmd == (v2) || (_cmd == v3)){ +# define SWITCH_DEFAULT }else{ +# define SWITCH_END }} +#endif + +#ifndef USB_RX_USER_HOOK +#define USB_RX_USER_HOOK(data, len) +#endif +#ifndef USB_SET_ADDRESS_HOOK +#define USB_SET_ADDRESS_HOOK() +#endif + +/* ------------------------------------------------------------------------- */ + +/* We use if() instead of #if in the macro below because #if can't be used + * in macros and the compiler optimizes constant conditions anyway. + * This may cause problems with undefined symbols if compiled without + * optimizing! + */ +#define GET_DESCRIPTOR(cfgProp, staticName) \ + if(cfgProp){ \ + if((cfgProp) & USB_PROP_IS_RAM) \ + flags = 0; \ + if((cfgProp) & USB_PROP_IS_DYNAMIC){ \ + len = usbFunctionDescriptor(rq); \ + }else{ \ + len = USB_PROP_LENGTH(cfgProp); \ + usbMsgPtr = (usbMsgPtr_t)(staticName); \ + } \ + } + +/* usbDriverDescriptor() is similar to usbFunctionDescriptor(), but used + * internally for all types of descriptors. + */ +static inline usbMsgLen_t usbDriverDescriptor(usbRequest_t *rq) +{ +usbMsgLen_t len = 0; +uchar flags = USB_FLG_MSGPTR_IS_ROM; + + SWITCH_START(rq->wValue.bytes[1]) + SWITCH_CASE(USBDESCR_DEVICE) /* 1 */ + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_DEVICE, usbDescriptorDevice) + SWITCH_CASE(USBDESCR_CONFIG) /* 2 */ + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_CONFIGURATION, usbDescriptorConfiguration) + SWITCH_CASE(USBDESCR_STRING) /* 3 */ +#if USB_CFG_DESCR_PROPS_STRINGS & USB_PROP_IS_DYNAMIC + if(USB_CFG_DESCR_PROPS_STRINGS & USB_PROP_IS_RAM) + flags = 0; + len = usbFunctionDescriptor(rq); +#else /* USB_CFG_DESCR_PROPS_STRINGS & USB_PROP_IS_DYNAMIC */ + SWITCH_START(rq->wValue.bytes[0]) + SWITCH_CASE(0) + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_STRING_0, usbDescriptorString0) + SWITCH_CASE(1) + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_STRING_VENDOR, usbDescriptorStringVendor) + SWITCH_CASE(2) + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_STRING_PRODUCT, usbDescriptorStringDevice) + SWITCH_CASE(3) + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_STRING_SERIAL_NUMBER, usbDescriptorStringSerialNumber) + SWITCH_DEFAULT + if(USB_CFG_DESCR_PROPS_UNKNOWN & USB_PROP_IS_DYNAMIC){ + len = usbFunctionDescriptor(rq); + } + SWITCH_END +#endif /* USB_CFG_DESCR_PROPS_STRINGS & USB_PROP_IS_DYNAMIC */ +#if USB_CFG_DESCR_PROPS_HID_REPORT /* only support HID descriptors if enabled */ + SWITCH_CASE(USBDESCR_HID) /* 0x21 */ + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_HID, usbDescriptorConfiguration + 18) + SWITCH_CASE(USBDESCR_HID_REPORT)/* 0x22 */ + GET_DESCRIPTOR(USB_CFG_DESCR_PROPS_HID_REPORT, usbDescriptorHidReport) +#endif + SWITCH_DEFAULT + if(USB_CFG_DESCR_PROPS_UNKNOWN & USB_PROP_IS_DYNAMIC){ + len = usbFunctionDescriptor(rq); + } + SWITCH_END + usbMsgFlags = flags; + return len; +} + +/* ------------------------------------------------------------------------- */ + +/* usbDriverSetup() is similar to usbFunctionSetup(), but it's used for + * standard requests instead of class and custom requests. + */ +static inline usbMsgLen_t usbDriverSetup(usbRequest_t *rq) +{ +usbMsgLen_t len = 0; +uchar *dataPtr = usbTxBuf + 9; /* there are 2 bytes free space at the end of the buffer */ +uchar value = rq->wValue.bytes[0]; +#if USB_CFG_IMPLEMENT_HALT +uchar index = rq->wIndex.bytes[0]; +#endif + + dataPtr[0] = 0; /* default reply common to USBRQ_GET_STATUS and USBRQ_GET_INTERFACE */ + SWITCH_START(rq->bRequest) + SWITCH_CASE(USBRQ_GET_STATUS) /* 0 */ + uchar recipient = rq->bmRequestType & USBRQ_RCPT_MASK; /* assign arith ops to variables to enforce byte size */ + if(USB_CFG_IS_SELF_POWERED && recipient == USBRQ_RCPT_DEVICE) + dataPtr[0] = USB_CFG_IS_SELF_POWERED; +#if USB_CFG_IMPLEMENT_HALT + if(recipient == USBRQ_RCPT_ENDPOINT && index == 0x81) /* request status for endpoint 1 */ + dataPtr[0] = usbTxLen1 == USBPID_STALL; +#endif + dataPtr[1] = 0; + len = 2; +#if USB_CFG_IMPLEMENT_HALT + SWITCH_CASE2(USBRQ_CLEAR_FEATURE, USBRQ_SET_FEATURE) /* 1, 3 */ + if(value == 0 && index == 0x81){ /* feature 0 == HALT for endpoint == 1 */ + usbTxLen1 = rq->bRequest == USBRQ_CLEAR_FEATURE ? USBPID_NAK : USBPID_STALL; + usbResetDataToggling(); + } +#endif + SWITCH_CASE(USBRQ_SET_ADDRESS) /* 5 */ + usbNewDeviceAddr = value; + USB_SET_ADDRESS_HOOK(); + SWITCH_CASE(USBRQ_GET_DESCRIPTOR) /* 6 */ + len = usbDriverDescriptor(rq); + goto skipMsgPtrAssignment; + SWITCH_CASE(USBRQ_GET_CONFIGURATION) /* 8 */ + dataPtr = &usbConfiguration; /* send current configuration value */ + len = 1; + SWITCH_CASE(USBRQ_SET_CONFIGURATION) /* 9 */ + usbConfiguration = value; + usbResetStall(); + SWITCH_CASE(USBRQ_GET_INTERFACE) /* 10 */ + len = 1; +#if USB_CFG_HAVE_INTRIN_ENDPOINT && !USB_CFG_SUPPRESS_INTR_CODE + SWITCH_CASE(USBRQ_SET_INTERFACE) /* 11 */ + usbResetDataToggling(); + usbResetStall(); +#endif + SWITCH_DEFAULT /* 7=SET_DESCRIPTOR, 12=SYNC_FRAME */ + /* Should we add an optional hook here? */ + SWITCH_END + usbMsgPtr = (usbMsgPtr_t)dataPtr; +skipMsgPtrAssignment: + return len; +} + +/* ------------------------------------------------------------------------- */ + +/* usbProcessRx() is called for every message received by the interrupt + * routine. It distinguishes between SETUP and DATA packets and processes + * them accordingly. + */ +static inline void usbProcessRx(uchar *data, uchar len) +{ +usbRequest_t *rq = (void *)data; + +/* usbRxToken can be: + * 0x2d 00101101 (USBPID_SETUP for setup data) + * 0xe1 11100001 (USBPID_OUT: data phase of setup transfer) + * 0...0x0f for OUT on endpoint X + */ + DBG2(0x10 + (usbRxToken & 0xf), data, len + 2); /* SETUP=1d, SETUP-DATA=11, OUTx=1x */ + USB_RX_USER_HOOK(data, len) +#if USB_CFG_IMPLEMENT_FN_WRITEOUT + if(usbRxToken < 0x10){ /* OUT to endpoint != 0: endpoint number in usbRxToken */ + usbFunctionWriteOut(data, len); + return; + } +#endif + if(usbRxToken == (uchar)USBPID_SETUP){ + if(len != 8) /* Setup size must be always 8 bytes. Ignore otherwise. */ + return; + usbMsgLen_t replyLen; + usbTxBuf[0] = USBPID_DATA0; /* initialize data toggling */ + usbTxLen = USBPID_NAK; /* abort pending transmit */ + usbMsgFlags = 0; + uchar type = rq->bmRequestType & USBRQ_TYPE_MASK; + if(type != USBRQ_TYPE_STANDARD){ /* standard requests are handled by driver */ + replyLen = usbFunctionSetup(data); + }else{ + replyLen = usbDriverSetup(rq); + } +#if USB_CFG_IMPLEMENT_FN_READ || USB_CFG_IMPLEMENT_FN_WRITE + if(replyLen == USB_NO_MSG){ /* use user-supplied read/write function */ + /* do some conditioning on replyLen, but on IN transfers only */ + if((rq->bmRequestType & USBRQ_DIR_MASK) != USBRQ_DIR_HOST_TO_DEVICE){ + if(sizeof(replyLen) < sizeof(rq->wLength.word)){ /* help compiler with optimizing */ + replyLen = rq->wLength.bytes[0]; + }else{ + replyLen = rq->wLength.word; + } + } + usbMsgFlags = USB_FLG_USE_USER_RW; + }else /* The 'else' prevents that we limit a replyLen of USB_NO_MSG to the maximum transfer len. */ +#endif + if(sizeof(replyLen) < sizeof(rq->wLength.word)){ /* help compiler with optimizing */ + if(!rq->wLength.bytes[1] && replyLen > rq->wLength.bytes[0]) /* limit length to max */ + replyLen = rq->wLength.bytes[0]; + }else{ + if(replyLen > rq->wLength.word) /* limit length to max */ + replyLen = rq->wLength.word; + } + usbMsgLen = replyLen; + }else{ /* usbRxToken must be USBPID_OUT, which means data phase of setup (control-out) */ +#if USB_CFG_IMPLEMENT_FN_WRITE + if(usbMsgFlags & USB_FLG_USE_USER_RW){ + uchar rval = usbFunctionWrite(data, len); + if(rval == 0xff){ /* an error occurred */ + usbTxLen = USBPID_STALL; + }else if(rval != 0){ /* This was the final package */ + usbMsgLen = 0; /* answer with a zero-sized data packet */ + } + } +#endif + } +} + +/* ------------------------------------------------------------------------- */ + +/* This function is similar to usbFunctionRead(), but it's also called for + * data handled automatically by the driver (e.g. descriptor reads). + */ +static uchar usbDeviceRead(uchar *data, uchar len) +{ + if(len > 0){ /* don't bother app with 0 sized reads */ +#if USB_CFG_IMPLEMENT_FN_READ + if(usbMsgFlags & USB_FLG_USE_USER_RW){ + len = usbFunctionRead(data, len); + }else +#endif + { + uchar i = len; + usbMsgPtr_t r = usbMsgPtr; + if(usbMsgFlags & USB_FLG_MSGPTR_IS_ROM){ /* ROM data */ + do{ + uchar c = USB_READ_FLASH(r); /* assign to char size variable to enforce byte ops */ + *data++ = c; + r++; + }while(--i); + }else{ /* RAM data */ + do{ + *data++ = *((uchar *)r); + r++; + }while(--i); + } + usbMsgPtr = r; + } + } + return len; +} + +/* ------------------------------------------------------------------------- */ + +/* usbBuildTxBlock() is called when we have data to transmit and the + * interrupt routine's transmit buffer is empty. + */ +static inline void usbBuildTxBlock(void) +{ +usbMsgLen_t wantLen; +uchar len; + + wantLen = usbMsgLen; + if(wantLen > 8) + wantLen = 8; + usbMsgLen -= wantLen; + usbTxBuf[0] ^= USBPID_DATA0 ^ USBPID_DATA1; /* DATA toggling */ + len = usbDeviceRead(usbTxBuf + 1, wantLen); + if(len <= 8){ /* valid data packet */ + usbCrc16Append(&usbTxBuf[1], len); + len += 4; /* length including sync byte */ + if(len < 12) /* a partial package identifies end of message */ + usbMsgLen = USB_NO_MSG; + }else{ + len = USBPID_STALL; /* stall the endpoint */ + usbMsgLen = USB_NO_MSG; + } + usbTxLen = len; + DBG2(0x20, usbTxBuf, len-1); +} + +/* ------------------------------------------------------------------------- */ + +static inline void usbHandleResetHook(uchar notResetState) +{ +#ifdef USB_RESET_HOOK +static uchar wasReset; +uchar isReset = !notResetState; + + if(wasReset != isReset){ + USB_RESET_HOOK(isReset); + wasReset = isReset; + } +#else + notResetState = notResetState; // avoid compiler warning +#endif +} + +/* ------------------------------------------------------------------------- */ + +USB_PUBLIC void usbPoll(void) +{ +schar len; +uchar i; + + len = usbRxLen - 3; + if(len >= 0){ +/* We could check CRC16 here -- but ACK has already been sent anyway. If you + * need data integrity checks with this driver, check the CRC in your app + * code and report errors back to the host. Since the ACK was already sent, + * retries must be handled on application level. + * unsigned crc = usbCrc16(buffer + 1, usbRxLen - 3); + */ + usbProcessRx(usbRxBuf + USB_BUFSIZE + 1 - usbInputBufOffset, len); +#if USB_CFG_HAVE_FLOWCONTROL + if(usbRxLen > 0) /* only mark as available if not inactivated */ + usbRxLen = 0; +#else + usbRxLen = 0; /* mark rx buffer as available */ +#endif + } + if(usbTxLen & 0x10){ /* transmit system idle */ + if(usbMsgLen != USB_NO_MSG){ /* transmit data pending? */ + usbBuildTxBlock(); + } + } + for(i = 20; i > 0; i--){ + uchar usbLineStatus = USBIN & USBMASK; + if(usbLineStatus != 0) /* SE0 has ended */ + goto isNotReset; + } + /* RESET condition, called multiple times during reset */ + usbNewDeviceAddr = 0; + usbDeviceAddr = 0; + usbResetStall(); + DBG1(0xff, 0, 0); +isNotReset: + usbHandleResetHook(i); +} + +/* ------------------------------------------------------------------------- */ + +USB_PUBLIC void usbInit(void) +{ +#if USB_INTR_CFG_SET != 0 + USB_INTR_CFG |= USB_INTR_CFG_SET; +#endif +#if USB_INTR_CFG_CLR != 0 + USB_INTR_CFG &= ~(USB_INTR_CFG_CLR); +#endif + USB_INTR_ENABLE |= (1 << USB_INTR_ENABLE_BIT); + usbResetDataToggling(); +#if USB_CFG_HAVE_INTRIN_ENDPOINT && !USB_CFG_SUPPRESS_INTR_CODE + usbTxLen1 = USBPID_NAK; +#if USB_CFG_HAVE_INTRIN_ENDPOINT3 + usbTxLen3 = USBPID_NAK; +#endif +#endif +} + +/* ------------------------------------------------------------------------- */ diff --git a/classic/fw/usbdrv/usbdrv.h b/classic/fw/usbdrv/usbdrv.h new file mode 100644 index 0000000..3fe84d5 --- /dev/null +++ b/classic/fw/usbdrv/usbdrv.h @@ -0,0 +1,746 @@ +/* Name: usbdrv.h + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Christian Starkjohann + * Creation Date: 2004-12-29 + * Tabsize: 4 + * Copyright: (c) 2005 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +#ifndef __usbdrv_h_included__ +#define __usbdrv_h_included__ +#include "usbconfig.h" +#include "usbportability.h" + +/* +Hardware Prerequisites: +======================= +USB lines D+ and D- MUST be wired to the same I/O port. We recommend that D+ +triggers the interrupt (best achieved by using INT0 for D+), but it is also +possible to trigger the interrupt from D-. If D- is used, interrupts are also +triggered by SOF packets. D- requires a pull-up of 1.5k to +3.5V (and the +device must be powered at 3.5V) to identify as low-speed USB device. A +pull-down or pull-up of 1M SHOULD be connected from D+ to +3.5V to prevent +interference when no USB master is connected. If you use Zener diodes to limit +the voltage on D+ and D-, you MUST use a pull-down resistor, not a pull-up. +We use D+ as interrupt source and not D- because it does not trigger on +keep-alive and RESET states. If you want to count keep-alive events with +USB_COUNT_SOF, you MUST use D- as an interrupt source. + +As a compile time option, the 1.5k pull-up resistor on D- can be made +switchable to allow the device to disconnect at will. See the definition of +usbDeviceConnect() and usbDeviceDisconnect() further down in this file. + +Please adapt the values in usbconfig.h according to your hardware! + +The device MUST be clocked at exactly 12 MHz, 15 MHz, 16 MHz or 20 MHz +or at 12.8 MHz resp. 16.5 MHz +/- 1%. See usbconfig-prototype.h for details. + + +Limitations: +============ +Robustness with respect to communication errors: +The driver assumes error-free communication. It DOES check for errors in +the PID, but does NOT check bit stuffing errors, SE0 in middle of a byte, +token CRC (5 bit) and data CRC (16 bit). CRC checks can not be performed due +to timing constraints: We must start sending a reply within 7 bit times. +Bit stuffing and misplaced SE0 would have to be checked in real-time, but CPU +performance does not permit that. The driver does not check Data0/Data1 +toggling, but application software can implement the check. + +Input characteristics: +Since no differential receiver circuit is used, electrical interference +robustness may suffer. The driver samples only one of the data lines with +an ordinary I/O pin's input characteristics. However, since this is only a +low speed USB implementation and the specification allows for 8 times the +bit rate over the same hardware, we should be on the safe side. Even the spec +requires detection of asymmetric states at high bit rate for SE0 detection. + +Number of endpoints: +The driver supports the following endpoints: + +- Endpoint 0, the default control endpoint. +- Any number of interrupt- or bulk-out endpoints. The data is sent to + usbFunctionWriteOut() and USB_CFG_IMPLEMENT_FN_WRITEOUT must be defined + to 1 to activate this feature. The endpoint number can be found in the + global variable 'usbRxToken'. +- One default interrupt- or bulk-in endpoint. This endpoint is used for + interrupt- or bulk-in transfers which are not handled by any other endpoint. + You must define USB_CFG_HAVE_INTRIN_ENDPOINT in order to activate this + feature and call usbSetInterrupt() to send interrupt/bulk data. +- One additional interrupt- or bulk-in endpoint. This was endpoint 3 in + previous versions of this driver but can now be configured to any endpoint + number. You must define USB_CFG_HAVE_INTRIN_ENDPOINT3 in order to activate + this feature and call usbSetInterrupt3() to send interrupt/bulk data. The + endpoint number can be set with USB_CFG_EP3_NUMBER. + +Please note that the USB standard forbids bulk endpoints for low speed devices! +Most operating systems allow them anyway, but the AVR will spend 90% of the CPU +time in the USB interrupt polling for bulk data. + +Maximum data payload: +Data payload of control in and out transfers may be up to 254 bytes. In order +to accept payload data of out transfers, you need to implement +'usbFunctionWrite()'. + +USB Suspend Mode supply current: +The USB standard limits power consumption to 500uA when the bus is in suspend +mode. This is not a problem for self-powered devices since they don't need +bus power anyway. Bus-powered devices can achieve this only by putting the +CPU in sleep mode. The driver does not implement suspend handling by itself. +However, the application may implement activity monitoring and wakeup from +sleep. The host sends regular SE0 states on the bus to keep it active. These +SE0 states can be detected by using D- as the interrupt source. Define +USB_COUNT_SOF to 1 and use the global variable usbSofCount to check for bus +activity. + +Operation without an USB master: +The driver behaves neutral without connection to an USB master if D- reads +as 1. To avoid spurious interrupts, we recommend a high impedance (e.g. 1M) +pull-down or pull-up resistor on D+ (interrupt). If Zener diodes are used, +use a pull-down. If D- becomes statically 0, the driver may block in the +interrupt routine. + +Interrupt latency: +The application must ensure that the USB interrupt is not disabled for more +than 25 cycles (this is for 12 MHz, faster clocks allow longer latency). +This implies that all interrupt routines must either have the "ISR_NOBLOCK" +attribute set (see "avr/interrupt.h") or be written in assembler with "sei" +as the first instruction. + +Maximum interrupt duration / CPU cycle consumption: +The driver handles all USB communication during the interrupt service +routine. The routine will not return before an entire USB message is received +and the reply is sent. This may be up to ca. 1200 cycles @ 12 MHz (= 100us) if +the host conforms to the standard. The driver will consume CPU cycles for all +USB messages, even if they address another (low-speed) device on the same bus. + +*/ + +/* ------------------------------------------------------------------------- */ +/* --------------------------- Module Interface ---------------------------- */ +/* ------------------------------------------------------------------------- */ + +#define USBDRV_VERSION 20121206 +/* This define uniquely identifies a driver version. It is a decimal number + * constructed from the driver's release date in the form YYYYMMDD. If the + * driver's behavior or interface changes, you can use this constant to + * distinguish versions. If it is not defined, the driver's release date is + * older than 2006-01-25. + */ + + +#ifndef USB_PUBLIC +#define USB_PUBLIC +#endif +/* USB_PUBLIC is used as declaration attribute for all functions exported by + * the USB driver. The default is no attribute (see above). You may define it + * to static either in usbconfig.h or from the command line if you include + * usbdrv.c instead of linking against it. Including the C module of the driver + * directly in your code saves a couple of bytes in flash memory. + */ + +#ifndef __ASSEMBLER__ +#ifndef uchar +#define uchar unsigned char +#endif +#ifndef schar +#define schar signed char +#endif +/* shortcuts for well defined 8 bit integer types */ + +#if USB_CFG_LONG_TRANSFERS /* if more than 254 bytes transfer size required */ +# define usbMsgLen_t unsigned +#else +# define usbMsgLen_t uchar +#endif +/* usbMsgLen_t is the data type used for transfer lengths. By default, it is + * defined to uchar, allowing a maximum of 254 bytes (255 is reserved for + * USB_NO_MSG below). If the usbconfig.h defines USB_CFG_LONG_TRANSFERS to 1, + * a 16 bit data type is used, allowing up to 16384 bytes (the rest is used + * for flags in the descriptor configuration). + */ +#define USB_NO_MSG ((usbMsgLen_t)-1) /* constant meaning "no message" */ + +#ifndef usbMsgPtr_t +#define usbMsgPtr_t uchar * +#endif +/* Making usbMsgPtr_t a define allows the user of this library to define it to + * an 8 bit type on tiny devices. This reduces code size, especially if the + * compiler supports a tiny memory model. + * The type can be a pointer or scalar type, casts are made where necessary. + * Although it's paradoxical, Gcc 4 generates slightly better code for scalar + * types than for pointers. + */ + +struct usbRequest; /* forward declaration */ + +USB_PUBLIC void usbInit(void); +/* This function must be called before interrupts are enabled and the main + * loop is entered. We exepct that the PORT and DDR bits for D+ and D- have + * not been changed from their default status (which is 0). If you have changed + * them, set both back to 0 (configure them as input with no internal pull-up). + */ +USB_PUBLIC void usbPoll(void); +/* This function must be called at regular intervals from the main loop. + * Maximum delay between calls is somewhat less than 50ms (USB timeout for + * accepting a Setup message). Otherwise the device will not be recognized. + * Please note that debug outputs through the UART take ~ 0.5ms per byte + * at 19200 bps. + */ +extern usbMsgPtr_t usbMsgPtr; +/* This variable may be used to pass transmit data to the driver from the + * implementation of usbFunctionWrite(). It is also used internally by the + * driver for standard control requests. + */ +USB_PUBLIC usbMsgLen_t usbFunctionSetup(uchar data[8]); +/* This function is called when the driver receives a SETUP transaction from + * the host which is not answered by the driver itself (in practice: class and + * vendor requests). All control transfers start with a SETUP transaction where + * the host communicates the parameters of the following (optional) data + * transfer. The SETUP data is available in the 'data' parameter which can + * (and should) be casted to 'usbRequest_t *' for a more user-friendly access + * to parameters. + * + * If the SETUP indicates a control-in transfer, you should provide the + * requested data to the driver. There are two ways to transfer this data: + * (1) Set the global pointer 'usbMsgPtr' to the base of the static RAM data + * block and return the length of the data in 'usbFunctionSetup()'. The driver + * will handle the rest. Or (2) return USB_NO_MSG in 'usbFunctionSetup()'. The + * driver will then call 'usbFunctionRead()' when data is needed. See the + * documentation for usbFunctionRead() for details. + * + * If the SETUP indicates a control-out transfer, the only way to receive the + * data from the host is through the 'usbFunctionWrite()' call. If you + * implement this function, you must return USB_NO_MSG in 'usbFunctionSetup()' + * to indicate that 'usbFunctionWrite()' should be used. See the documentation + * of this function for more information. If you just want to ignore the data + * sent by the host, return 0 in 'usbFunctionSetup()'. + * + * Note that calls to the functions usbFunctionRead() and usbFunctionWrite() + * are only done if enabled by the configuration in usbconfig.h. + */ +USB_PUBLIC usbMsgLen_t usbFunctionDescriptor(struct usbRequest *rq); +/* You need to implement this function ONLY if you provide USB descriptors at + * runtime (which is an expert feature). It is very similar to + * usbFunctionSetup() above, but it is called only to request USB descriptor + * data. See the documentation of usbFunctionSetup() above for more info. + */ +#if USB_CFG_HAVE_INTRIN_ENDPOINT +USB_PUBLIC void usbSetInterrupt(uchar *data, uchar len); +/* This function sets the message which will be sent during the next interrupt + * IN transfer. The message is copied to an internal buffer and must not exceed + * a length of 8 bytes. The message may be 0 bytes long just to indicate the + * interrupt status to the host. + * If you need to transfer more bytes, use a control read after the interrupt. + */ +#define usbInterruptIsReady() (usbTxLen1 & 0x10) +/* This macro indicates whether the last interrupt message has already been + * sent. If you set a new interrupt message before the old was sent, the + * message already buffered will be lost. + */ +#if USB_CFG_HAVE_INTRIN_ENDPOINT3 +USB_PUBLIC void usbSetInterrupt3(uchar *data, uchar len); +#define usbInterruptIsReady3() (usbTxLen3 & 0x10) +/* Same as above for endpoint 3 */ +#endif +#endif /* USB_CFG_HAVE_INTRIN_ENDPOINT */ +#if USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH /* simplified interface for backward compatibility */ +#define usbHidReportDescriptor usbDescriptorHidReport +/* should be declared as: PROGMEM char usbHidReportDescriptor[]; */ +/* If you implement an HID device, you need to provide a report descriptor. + * The HID report descriptor syntax is a bit complex. If you understand how + * report descriptors are constructed, we recommend that you use the HID + * Descriptor Tool from usb.org, see http://www.usb.org/developers/hidpage/. + * Otherwise you should probably start with a working example. + */ +#endif /* USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH */ +#if USB_CFG_IMPLEMENT_FN_WRITE +USB_PUBLIC uchar usbFunctionWrite(uchar *data, uchar len); +/* This function is called by the driver to provide a control transfer's + * payload data (control-out). It is called in chunks of up to 8 bytes. The + * total count provided in the current control transfer can be obtained from + * the 'length' property in the setup data. If an error occurred during + * processing, return 0xff (== -1). The driver will answer the entire transfer + * with a STALL token in this case. If you have received the entire payload + * successfully, return 1. If you expect more data, return 0. If you don't + * know whether the host will send more data (you should know, the total is + * provided in the usbFunctionSetup() call!), return 1. + * NOTE: If you return 0xff for STALL, 'usbFunctionWrite()' may still be called + * for the remaining data. You must continue to return 0xff for STALL in these + * calls. + * In order to get usbFunctionWrite() called, define USB_CFG_IMPLEMENT_FN_WRITE + * to 1 in usbconfig.h and return 0xff in usbFunctionSetup().. + */ +#endif /* USB_CFG_IMPLEMENT_FN_WRITE */ +#if USB_CFG_IMPLEMENT_FN_READ +USB_PUBLIC uchar usbFunctionRead(uchar *data, uchar len); +/* This function is called by the driver to ask the application for a control + * transfer's payload data (control-in). It is called in chunks of up to 8 + * bytes each. You should copy the data to the location given by 'data' and + * return the actual number of bytes copied. If you return less than requested, + * the control-in transfer is terminated. If you return 0xff, the driver aborts + * the transfer with a STALL token. + * In order to get usbFunctionRead() called, define USB_CFG_IMPLEMENT_FN_READ + * to 1 in usbconfig.h and return 0xff in usbFunctionSetup().. + */ +#endif /* USB_CFG_IMPLEMENT_FN_READ */ + +extern uchar usbRxToken; /* may be used in usbFunctionWriteOut() below */ +#if USB_CFG_IMPLEMENT_FN_WRITEOUT +USB_PUBLIC void usbFunctionWriteOut(uchar *data, uchar len); +/* This function is called by the driver when data is received on an interrupt- + * or bulk-out endpoint. The endpoint number can be found in the global + * variable usbRxToken. You must define USB_CFG_IMPLEMENT_FN_WRITEOUT to 1 in + * usbconfig.h to get this function called. + */ +#endif /* USB_CFG_IMPLEMENT_FN_WRITEOUT */ +#ifdef USB_CFG_PULLUP_IOPORTNAME +#define usbDeviceConnect() ((USB_PULLUP_DDR |= (1<device, 1=device->host + * t ..... type: 0=standard, 1=class, 2=vendor, 3=reserved + * r ..... recipient: 0=device, 1=interface, 2=endpoint, 3=other + */ + +/* USB setup recipient values */ +#define USBRQ_RCPT_MASK 0x1f +#define USBRQ_RCPT_DEVICE 0 +#define USBRQ_RCPT_INTERFACE 1 +#define USBRQ_RCPT_ENDPOINT 2 + +/* USB request type values */ +#define USBRQ_TYPE_MASK 0x60 +#define USBRQ_TYPE_STANDARD (0<<5) +#define USBRQ_TYPE_CLASS (1<<5) +#define USBRQ_TYPE_VENDOR (2<<5) + +/* USB direction values: */ +#define USBRQ_DIR_MASK 0x80 +#define USBRQ_DIR_HOST_TO_DEVICE (0<<7) +#define USBRQ_DIR_DEVICE_TO_HOST (1<<7) + +/* USB Standard Requests */ +#define USBRQ_GET_STATUS 0 +#define USBRQ_CLEAR_FEATURE 1 +#define USBRQ_SET_FEATURE 3 +#define USBRQ_SET_ADDRESS 5 +#define USBRQ_GET_DESCRIPTOR 6 +#define USBRQ_SET_DESCRIPTOR 7 +#define USBRQ_GET_CONFIGURATION 8 +#define USBRQ_SET_CONFIGURATION 9 +#define USBRQ_GET_INTERFACE 10 +#define USBRQ_SET_INTERFACE 11 +#define USBRQ_SYNCH_FRAME 12 + +/* USB descriptor constants */ +#define USBDESCR_DEVICE 1 +#define USBDESCR_CONFIG 2 +#define USBDESCR_STRING 3 +#define USBDESCR_INTERFACE 4 +#define USBDESCR_ENDPOINT 5 +#define USBDESCR_HID 0x21 +#define USBDESCR_HID_REPORT 0x22 +#define USBDESCR_HID_PHYS 0x23 + +//#define USBATTR_BUSPOWER 0x80 // USB 1.1 does not define this value any more +#define USBATTR_BUSPOWER 0 +#define USBATTR_SELFPOWER 0x40 +#define USBATTR_REMOTEWAKE 0x20 + +/* USB HID Requests */ +#define USBRQ_HID_GET_REPORT 0x01 +#define USBRQ_HID_GET_IDLE 0x02 +#define USBRQ_HID_GET_PROTOCOL 0x03 +#define USBRQ_HID_SET_REPORT 0x09 +#define USBRQ_HID_SET_IDLE 0x0a +#define USBRQ_HID_SET_PROTOCOL 0x0b + +/* ------------------------------------------------------------------------- */ + +#endif /* __usbdrv_h_included__ */ diff --git a/classic/fw/usbdrv/usbdrvasm.S b/classic/fw/usbdrv/usbdrvasm.S new file mode 100644 index 0000000..32ce8ef --- /dev/null +++ b/classic/fw/usbdrv/usbdrvasm.S @@ -0,0 +1,392 @@ +/* Name: usbdrvasm.S + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Christian Starkjohann + * Creation Date: 2007-06-13 + * Tabsize: 4 + * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +/* +General Description: +This module is the assembler part of the USB driver. This file contains +general code (preprocessor acrobatics and CRC computation) and then includes +the file appropriate for the given clock rate. +*/ + +#define __SFR_OFFSET 0 /* used by avr-libc's register definitions */ +#include "usbportability.h" +#include "usbdrv.h" /* for common defs */ + +/* register names */ +#define x1 r16 +#define x2 r17 +#define shift r18 +#define cnt r19 +#define x3 r20 +#define x4 r21 +#define x5 r22 +#define bitcnt x5 +#define phase x4 +#define leap x4 + +/* Some assembler dependent definitions and declarations: */ + +#ifdef __IAR_SYSTEMS_ASM__ + extern usbRxBuf, usbDeviceAddr, usbNewDeviceAddr, usbInputBufOffset + extern usbCurrentTok, usbRxLen, usbRxToken, usbTxLen + extern usbTxBuf, usbTxStatus1, usbTxStatus3 +# if USB_COUNT_SOF + extern usbSofCount +# endif + public usbCrc16 + public usbCrc16Append + + COMMON INTVEC +# ifndef USB_INTR_VECTOR + ORG INT0_vect +# else /* USB_INTR_VECTOR */ + ORG USB_INTR_VECTOR +# undef USB_INTR_VECTOR +# endif /* USB_INTR_VECTOR */ +# define USB_INTR_VECTOR usbInterruptHandler + rjmp USB_INTR_VECTOR + RSEG CODE + +#else /* __IAR_SYSTEMS_ASM__ */ + +# ifndef USB_INTR_VECTOR /* default to hardware interrupt INT0 */ +# ifdef INT0_vect +# define USB_INTR_VECTOR INT0_vect // this is the "new" define for the vector +# else +# define USB_INTR_VECTOR SIG_INTERRUPT0 // this is the "old" vector +# endif +# endif + .text + .global USB_INTR_VECTOR + .type USB_INTR_VECTOR, @function + .global usbCrc16 + .global usbCrc16Append +#endif /* __IAR_SYSTEMS_ASM__ */ + + +#if USB_INTR_PENDING < 0x40 /* This is an I/O address, use in and out */ +# define USB_LOAD_PENDING(reg) in reg, USB_INTR_PENDING +# define USB_STORE_PENDING(reg) out USB_INTR_PENDING, reg +#else /* It's a memory address, use lds and sts */ +# define USB_LOAD_PENDING(reg) lds reg, USB_INTR_PENDING +# define USB_STORE_PENDING(reg) sts USB_INTR_PENDING, reg +#endif + +#define usbTxLen1 usbTxStatus1 +#define usbTxBuf1 (usbTxStatus1 + 1) +#define usbTxLen3 usbTxStatus3 +#define usbTxBuf3 (usbTxStatus3 + 1) + + +;---------------------------------------------------------------------------- +; Utility functions +;---------------------------------------------------------------------------- + +#ifdef __IAR_SYSTEMS_ASM__ +/* Register assignments for usbCrc16 on IAR cc */ +/* Calling conventions on IAR: + * First parameter passed in r16/r17, second in r18/r19 and so on. + * Callee must preserve r4-r15, r24-r29 (r28/r29 is frame pointer) + * Result is passed in r16/r17 + * In case of the "tiny" memory model, pointers are only 8 bit with no + * padding. We therefore pass argument 1 as "16 bit unsigned". + */ +RTMODEL "__rt_version", "3" +/* The line above will generate an error if cc calling conventions change. + * The value "3" above is valid for IAR 4.10B/W32 + */ +# define argLen r18 /* argument 2 */ +# define argPtrL r16 /* argument 1 */ +# define argPtrH r17 /* argument 1 */ + +# define resCrcL r16 /* result */ +# define resCrcH r17 /* result */ + +# define ptrL ZL +# define ptrH ZH +# define ptr Z +# define byte r22 +# define bitCnt r19 +# define polyL r20 +# define polyH r21 +# define scratch r23 + +#else /* __IAR_SYSTEMS_ASM__ */ +/* Register assignments for usbCrc16 on gcc */ +/* Calling conventions on gcc: + * First parameter passed in r24/r25, second in r22/23 and so on. + * Callee must preserve r1-r17, r28/r29 + * Result is passed in r24/r25 + */ +# define argLen r22 /* argument 2 */ +# define argPtrL r24 /* argument 1 */ +# define argPtrH r25 /* argument 1 */ + +# define resCrcL r24 /* result */ +# define resCrcH r25 /* result */ + +# define ptrL XL +# define ptrH XH +# define ptr x +# define byte r18 +# define bitCnt r19 +# define polyL r20 +# define polyH r21 +# define scratch r23 + +#endif + +#if USB_USE_FAST_CRC + +; This implementation is faster, but has bigger code size +; Thanks to Slawomir Fras (BoskiDialer) for this code! +; It implements the following C pseudo-code: +; unsigned table(unsigned char x) +; { +; unsigned value; +; +; value = (unsigned)x << 6; +; value ^= (unsigned)x << 7; +; if(parity(x)) +; value ^= 0xc001; +; return value; +; } +; unsigned usbCrc16(unsigned char *argPtr, unsigned char argLen) +; { +; unsigned crc = 0xffff; +; +; while(argLen--) +; crc = table(lo8(crc) ^ *argPtr++) ^ hi8(crc); +; return ~crc; +; } + +; extern unsigned usbCrc16(unsigned char *argPtr, unsigned char argLen); +; argPtr r24+25 / r16+r17 +; argLen r22 / r18 +; temp variables: +; byte r18 / r22 +; scratch r23 +; resCrc r24+r25 / r16+r17 +; ptr X / Z +usbCrc16: + mov ptrL, argPtrL + mov ptrH, argPtrH + ldi resCrcL, 0xFF + ldi resCrcH, 0xFF + rjmp usbCrc16LoopTest +usbCrc16ByteLoop: + ld byte, ptr+ + eor resCrcL, byte ; resCrcL is now 'x' in table() + mov byte, resCrcL ; compute parity of 'x' + swap byte + eor byte, resCrcL + mov scratch, byte + lsr byte + lsr byte + eor byte, scratch + inc byte + lsr byte + andi byte, 1 ; byte is now parity(x) + mov scratch, resCrcL + mov resCrcL, resCrcH + eor resCrcL, byte ; low byte of if(parity(x)) value ^= 0xc001; + neg byte + andi byte, 0xc0 + mov resCrcH, byte ; high byte of if(parity(x)) value ^= 0xc001; + clr byte + lsr scratch + ror byte + eor resCrcH, scratch + eor resCrcL, byte + lsr scratch + ror byte + eor resCrcH, scratch + eor resCrcL, byte +usbCrc16LoopTest: + subi argLen, 1 + brsh usbCrc16ByteLoop + com resCrcL + com resCrcH + ret + +#else /* USB_USE_FAST_CRC */ + +; This implementation is slower, but has less code size +; +; extern unsigned usbCrc16(unsigned char *argPtr, unsigned char argLen); +; argPtr r24+25 / r16+r17 +; argLen r22 / r18 +; temp variables: +; byte r18 / r22 +; bitCnt r19 +; poly r20+r21 +; scratch r23 +; resCrc r24+r25 / r16+r17 +; ptr X / Z +usbCrc16: + mov ptrL, argPtrL + mov ptrH, argPtrH + ldi resCrcL, 0 + ldi resCrcH, 0 + ldi polyL, lo8(0xa001) + ldi polyH, hi8(0xa001) + com argLen ; argLen = -argLen - 1: modified loop to ensure that carry is set + ldi bitCnt, 0 ; loop counter with starnd condition = end condition + rjmp usbCrcLoopEntry +usbCrcByteLoop: + ld byte, ptr+ + eor resCrcL, byte +usbCrcBitLoop: + ror resCrcH ; carry is always set here (see brcs jumps to here) + ror resCrcL + brcs usbCrcNoXor + eor resCrcL, polyL + eor resCrcH, polyH +usbCrcNoXor: + subi bitCnt, 224 ; (8 * 224) % 256 = 0; this loop iterates 8 times + brcs usbCrcBitLoop +usbCrcLoopEntry: + subi argLen, -1 + brcs usbCrcByteLoop +usbCrcReady: + ret +; Thanks to Reimar Doeffinger for optimizing this CRC routine! + +#endif /* USB_USE_FAST_CRC */ + +; extern unsigned usbCrc16Append(unsigned char *data, unsigned char len); +usbCrc16Append: + rcall usbCrc16 + st ptr+, resCrcL + st ptr+, resCrcH + ret + +#undef argLen +#undef argPtrL +#undef argPtrH +#undef resCrcL +#undef resCrcH +#undef ptrL +#undef ptrH +#undef ptr +#undef byte +#undef bitCnt +#undef polyL +#undef polyH +#undef scratch + + +#if USB_CFG_HAVE_MEASURE_FRAME_LENGTH +#ifdef __IAR_SYSTEMS_ASM__ +/* Register assignments for usbMeasureFrameLength on IAR cc */ +/* Calling conventions on IAR: + * First parameter passed in r16/r17, second in r18/r19 and so on. + * Callee must preserve r4-r15, r24-r29 (r28/r29 is frame pointer) + * Result is passed in r16/r17 + * In case of the "tiny" memory model, pointers are only 8 bit with no + * padding. We therefore pass argument 1 as "16 bit unsigned". + */ +# define resL r16 +# define resH r17 +# define cnt16L r30 +# define cnt16H r31 +# define cntH r18 + +#else /* __IAR_SYSTEMS_ASM__ */ +/* Register assignments for usbMeasureFrameLength on gcc */ +/* Calling conventions on gcc: + * First parameter passed in r24/r25, second in r22/23 and so on. + * Callee must preserve r1-r17, r28/r29 + * Result is passed in r24/r25 + */ +# define resL r24 +# define resH r25 +# define cnt16L r24 +# define cnt16H r25 +# define cntH r26 +#endif +# define cnt16 cnt16L + +; extern unsigned usbMeasurePacketLength(void); +; returns time between two idle strobes in multiples of 7 CPU clocks +.global usbMeasureFrameLength +usbMeasureFrameLength: + ldi cntH, 6 ; wait ~ 10 ms for D- == 0 + clr cnt16L + clr cnt16H +usbMFTime16: + dec cntH + breq usbMFTimeout +usbMFWaitStrobe: ; first wait for D- == 0 (idle strobe) + sbiw cnt16, 1 ;[0] [6] + breq usbMFTime16 ;[2] + sbic USBIN, USBMINUS ;[3] + rjmp usbMFWaitStrobe ;[4] +usbMFWaitIdle: ; then wait until idle again + sbis USBIN, USBMINUS ;1 wait for D- == 1 + rjmp usbMFWaitIdle ;2 + ldi cnt16L, 1 ;1 represents cycles so far + clr cnt16H ;1 +usbMFWaitLoop: + in cntH, USBIN ;[0] [7] + adiw cnt16, 1 ;[1] + breq usbMFTimeout ;[3] + andi cntH, USBMASK ;[4] + brne usbMFWaitLoop ;[5] +usbMFTimeout: +#if resL != cnt16L + mov resL, cnt16L + mov resH, cnt16H +#endif + ret + +#undef resL +#undef resH +#undef cnt16 +#undef cnt16L +#undef cnt16H +#undef cntH + +#endif /* USB_CFG_HAVE_MEASURE_FRAME_LENGTH */ + +;---------------------------------------------------------------------------- +; Now include the clock rate specific code +;---------------------------------------------------------------------------- + +#ifndef USB_CFG_CLOCK_KHZ +# ifdef F_CPU +# define USB_CFG_CLOCK_KHZ (F_CPU/1000) +# else +# error "USB_CFG_CLOCK_KHZ not defined in usbconfig.h and no F_CPU set!" +# endif +#endif + +#if USB_CFG_CHECK_CRC /* separate dispatcher for CRC type modules */ +# if USB_CFG_CLOCK_KHZ == 18000 +# include "usbdrvasm18-crc.inc" +# else +# error "USB_CFG_CLOCK_KHZ is not one of the supported crc-rates!" +# endif +#else /* USB_CFG_CHECK_CRC */ +# if USB_CFG_CLOCK_KHZ == 12000 +# include "usbdrvasm12.inc" +# elif USB_CFG_CLOCK_KHZ == 12800 +# include "usbdrvasm128.inc" +# elif USB_CFG_CLOCK_KHZ == 15000 +# include "usbdrvasm15.inc" +# elif USB_CFG_CLOCK_KHZ == 16000 +# include "usbdrvasm16.inc" +# elif USB_CFG_CLOCK_KHZ == 16500 +# include "usbdrvasm165.inc" +# elif USB_CFG_CLOCK_KHZ == 20000 +# include "usbdrvasm20.inc" +# else +# error "USB_CFG_CLOCK_KHZ is not one of the supported non-crc-rates!" +# endif +#endif /* USB_CFG_CHECK_CRC */ diff --git a/classic/fw/usbdrv/usbdrvasm.asm b/classic/fw/usbdrv/usbdrvasm.asm new file mode 100644 index 0000000..fb66934 --- /dev/null +++ b/classic/fw/usbdrv/usbdrvasm.asm @@ -0,0 +1,20 @@ +/* Name: usbdrvasm.asm + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Christian Starkjohann + * Creation Date: 2006-03-01 + * Tabsize: 4 + * Copyright: (c) 2006 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +/* +General Description: +The IAR compiler/assembler system prefers assembler files with file extension +".asm". We simply provide this file as an alias for usbdrvasm.S. + +Thanks to Oleg Semyonov for his help with the IAR tools port! +*/ + +#include "usbdrvasm.S" + +end diff --git a/classic/fw/usbdrv/usbdrvasm12.inc b/classic/fw/usbdrv/usbdrvasm12.inc new file mode 100644 index 0000000..d3bd056 --- /dev/null +++ b/classic/fw/usbdrv/usbdrvasm12.inc @@ -0,0 +1,392 @@ +/* Name: usbdrvasm12.inc + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Christian Starkjohann + * Creation Date: 2004-12-29 + * Tabsize: 4 + * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +/* Do not link this file! Link usbdrvasm.S instead, which includes the + * appropriate implementation! + */ + +/* +General Description: +This file is the 12 MHz version of the asssembler part of the USB driver. It +requires a 12 MHz crystal (not a ceramic resonator and not a calibrated RC +oscillator). + +See usbdrv.h for a description of the entire driver. + +Since almost all of this code is timing critical, don't change unless you +really know what you are doing! Many parts require not only a maximum number +of CPU cycles, but even an exact number of cycles! + + +Timing constraints according to spec (in bit times): +timing subject min max CPUcycles +--------------------------------------------------------------------------- +EOP of OUT/SETUP to sync pattern of DATA0 (both rx) 2 16 16-128 +EOP of IN to sync pattern of DATA0 (rx, then tx) 2 7.5 16-60 +DATAx (rx) to ACK/NAK/STALL (tx) 2 7.5 16-60 +*/ + +;Software-receiver engine. Strict timing! Don't change unless you can preserve timing! +;interrupt response time: 4 cycles + insn running = 7 max if interrupts always enabled +;max allowable interrupt latency: 34 cycles -> max 25 cycles interrupt disable +;max stack usage: [ret(2), YL, SREG, YH, shift, x1, x2, x3, cnt, x4] = 11 bytes +;Numbers in brackets are maximum cycles since SOF. +USB_INTR_VECTOR: +;order of registers pushed: YL, SREG [sofError], YH, shift, x1, x2, x3, cnt + push YL ;2 [35] push only what is necessary to sync with edge ASAP + in YL, SREG ;1 [37] + push YL ;2 [39] +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +;---------------------------------------------------------------------------- +;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +;sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +waitForK: +;The following code results in a sampling window of 1/4 bit which meets the spec. + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError +foundK: +;{3, 5} after falling D- edge, average delay: 4 cycles [we want 4 for center sampling] +;we have 1 bit time for setup purposes, then sample again. Numbers in brackets +;are cycles from center of first sync (double K) bit after the instruction + push YH ;2 [2] + lds YL, usbInputBufOffset;2 [4] + clr YH ;1 [5] + subi YL, lo8(-(usbRxBuf));1 [6] + sbci YH, hi8(-(usbRxBuf));1 [7] + + sbis USBIN, USBMINUS ;1 [8] we want two bits K [sample 1 cycle too early] + rjmp haveTwoBitsK ;2 [10] + pop YH ;2 [11] undo the push from before + rjmp waitForK ;2 [13] this was not the end of sync, retry +haveTwoBitsK: +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- + push shift ;2 [16] + push x1 ;2 [12] + push x2 ;2 [14] + + in x1, USBIN ;1 [17] <-- sample bit 0 + ldi shift, 0xff ;1 [18] + bst x1, USBMINUS ;1 [19] + bld shift, 0 ;1 [20] + push x3 ;2 [22] + push cnt ;2 [24] + + in x2, USBIN ;1 [25] <-- sample bit 1 + ser x3 ;1 [26] [inserted init instruction] + eor x1, x2 ;1 [27] + bst x1, USBMINUS ;1 [28] + bld shift, 1 ;1 [29] + ldi cnt, USB_BUFSIZE;1 [30] [inserted init instruction] + rjmp rxbit2 ;2 [32] + +;---------------------------------------------------------------------------- +; Receiver loop (numbers in brackets are cycles within byte after instr) +;---------------------------------------------------------------------------- + +unstuff0: ;1 (branch taken) + andi x3, ~0x01 ;1 [15] + mov x1, x2 ;1 [16] x2 contains last sampled (stuffed) bit + in x2, USBIN ;1 [17] <-- sample bit 1 again + ori shift, 0x01 ;1 [18] + rjmp didUnstuff0 ;2 [20] + +unstuff1: ;1 (branch taken) + mov x2, x1 ;1 [21] x1 contains last sampled (stuffed) bit + andi x3, ~0x02 ;1 [22] + ori shift, 0x02 ;1 [23] + nop ;1 [24] + in x1, USBIN ;1 [25] <-- sample bit 2 again + rjmp didUnstuff1 ;2 [27] + +unstuff2: ;1 (branch taken) + andi x3, ~0x04 ;1 [29] + ori shift, 0x04 ;1 [30] + mov x1, x2 ;1 [31] x2 contains last sampled (stuffed) bit + nop ;1 [32] + in x2, USBIN ;1 [33] <-- sample bit 3 + rjmp didUnstuff2 ;2 [35] + +unstuff3: ;1 (branch taken) + in x2, USBIN ;1 [34] <-- sample stuffed bit 3 [one cycle too late] + andi x3, ~0x08 ;1 [35] + ori shift, 0x08 ;1 [36] + rjmp didUnstuff3 ;2 [38] + +unstuff4: ;1 (branch taken) + andi x3, ~0x10 ;1 [40] + in x1, USBIN ;1 [41] <-- sample stuffed bit 4 + ori shift, 0x10 ;1 [42] + rjmp didUnstuff4 ;2 [44] + +unstuff5: ;1 (branch taken) + andi x3, ~0x20 ;1 [48] + in x2, USBIN ;1 [49] <-- sample stuffed bit 5 + ori shift, 0x20 ;1 [50] + rjmp didUnstuff5 ;2 [52] + +unstuff6: ;1 (branch taken) + andi x3, ~0x40 ;1 [56] + in x1, USBIN ;1 [57] <-- sample stuffed bit 6 + ori shift, 0x40 ;1 [58] + rjmp didUnstuff6 ;2 [60] + +; extra jobs done during bit interval: +; bit 0: store, clear [SE0 is unreliable here due to bit dribbling in hubs] +; bit 1: se0 check +; bit 2: overflow check +; bit 3: recovery from delay [bit 0 tasks took too long] +; bit 4: none +; bit 5: none +; bit 6: none +; bit 7: jump, eor +rxLoop: + eor x3, shift ;1 [0] reconstruct: x3 is 0 at bit locations we changed, 1 at others + in x1, USBIN ;1 [1] <-- sample bit 0 + st y+, x3 ;2 [3] store data + ser x3 ;1 [4] + nop ;1 [5] + eor x2, x1 ;1 [6] + bst x2, USBMINUS;1 [7] + bld shift, 0 ;1 [8] + in x2, USBIN ;1 [9] <-- sample bit 1 (or possibly bit 0 stuffed) + andi x2, USBMASK ;1 [10] + breq se0 ;1 [11] SE0 check for bit 1 + andi shift, 0xf9 ;1 [12] +didUnstuff0: + breq unstuff0 ;1 [13] + eor x1, x2 ;1 [14] + bst x1, USBMINUS;1 [15] + bld shift, 1 ;1 [16] +rxbit2: + in x1, USBIN ;1 [17] <-- sample bit 2 (or possibly bit 1 stuffed) + andi shift, 0xf3 ;1 [18] + breq unstuff1 ;1 [19] do remaining work for bit 1 +didUnstuff1: + subi cnt, 1 ;1 [20] + brcs overflow ;1 [21] loop control + eor x2, x1 ;1 [22] + bst x2, USBMINUS;1 [23] + bld shift, 2 ;1 [24] + in x2, USBIN ;1 [25] <-- sample bit 3 (or possibly bit 2 stuffed) + andi shift, 0xe7 ;1 [26] + breq unstuff2 ;1 [27] +didUnstuff2: + eor x1, x2 ;1 [28] + bst x1, USBMINUS;1 [29] + bld shift, 3 ;1 [30] +didUnstuff3: + andi shift, 0xcf ;1 [31] + breq unstuff3 ;1 [32] + in x1, USBIN ;1 [33] <-- sample bit 4 + eor x2, x1 ;1 [34] + bst x2, USBMINUS;1 [35] + bld shift, 4 ;1 [36] +didUnstuff4: + andi shift, 0x9f ;1 [37] + breq unstuff4 ;1 [38] + nop2 ;2 [40] + in x2, USBIN ;1 [41] <-- sample bit 5 + eor x1, x2 ;1 [42] + bst x1, USBMINUS;1 [43] + bld shift, 5 ;1 [44] +didUnstuff5: + andi shift, 0x3f ;1 [45] + breq unstuff5 ;1 [46] + nop2 ;2 [48] + in x1, USBIN ;1 [49] <-- sample bit 6 + eor x2, x1 ;1 [50] + bst x2, USBMINUS;1 [51] + bld shift, 6 ;1 [52] +didUnstuff6: + cpi shift, 0x02 ;1 [53] + brlo unstuff6 ;1 [54] + nop2 ;2 [56] + in x2, USBIN ;1 [57] <-- sample bit 7 + eor x1, x2 ;1 [58] + bst x1, USBMINUS;1 [59] + bld shift, 7 ;1 [60] +didUnstuff7: + cpi shift, 0x04 ;1 [61] + brsh rxLoop ;2 [63] loop control +unstuff7: + andi x3, ~0x80 ;1 [63] + ori shift, 0x80 ;1 [64] + in x2, USBIN ;1 [65] <-- sample stuffed bit 7 + nop ;1 [66] + rjmp didUnstuff7 ;2 [68] + +macro POP_STANDARD ; 12 cycles + pop cnt + pop x3 + pop x2 + pop x1 + pop shift + pop YH + endm +macro POP_RETI ; 5 cycles + pop YL + out SREG, YL + pop YL + endm + +#include "asmcommon.inc" + +;---------------------------------------------------------------------------- +; Transmitting data +;---------------------------------------------------------------------------- + +txByteLoop: +txBitloop: +stuffN1Delay: ; [03] + ror shift ;[-5] [11] [59] + brcc doExorN1 ;[-4] [60] + subi x4, 1 ;[-3] + brne commonN1 ;[-2] + lsl shift ;[-1] compensate ror after rjmp stuffDelay + nop ;[00] stuffing consists of just waiting 8 cycles + rjmp stuffN1Delay ;[01] after ror, C bit is reliably clear + +sendNakAndReti: ;0 [-19] 19 cycles until SOP + ldi x3, USBPID_NAK ;1 [-18] + rjmp usbSendX3 ;2 [-16] +sendAckAndReti: ;0 [-19] 19 cycles until SOP + ldi x3, USBPID_ACK ;1 [-18] + rjmp usbSendX3 ;2 [-16] +sendCntAndReti: ;0 [-17] 17 cycles until SOP + mov x3, cnt ;1 [-16] +usbSendX3: ;0 [-16] + ldi YL, 20 ;1 [-15] 'x3' is R20 + ldi YH, 0 ;1 [-14] + ldi cnt, 2 ;1 [-13] +; rjmp usbSendAndReti fallthrough + +; USB spec says: +; idle = J +; J = (D+ = 0), (D- = 1) or USBOUT = 0x01 +; K = (D+ = 1), (D- = 0) or USBOUT = 0x02 +; Spec allows 7.5 bit times from EOP to SOP for replies (= 60 cycles) + +;usbSend: +;pointer to data in 'Y' +;number of bytes in 'cnt' -- including sync byte +;uses: x1...x2, x4, shift, cnt, Y [x1 = mirror USBOUT, x2 = USBMASK, x4 = bitstuff cnt] +;Numbers in brackets are time since first bit of sync pattern is sent (start of instruction) +usbSendAndReti: + in x2, USBDDR ;[-12] 12 cycles until SOP + ori x2, USBMASK ;[-11] + sbi USBOUT, USBMINUS ;[-10] prepare idle state; D+ and D- must have been 0 (no pullups) + out USBDDR, x2 ;[-8] <--- acquire bus + in x1, USBOUT ;[-7] port mirror for tx loop + ldi shift, 0x40 ;[-6] sync byte is first byte sent (we enter loop after ror) + ldi x2, USBMASK ;[-5] + push x4 ;[-4] +doExorN1: + eor x1, x2 ;[-2] [06] [62] + ldi x4, 6 ;[-1] [07] [63] +commonN1: +stuffN2Delay: + out USBOUT, x1 ;[00] [08] [64] <--- set bit + ror shift ;[01] + brcc doExorN2 ;[02] + subi x4, 1 ;[03] + brne commonN2 ;[04] + lsl shift ;[05] compensate ror after rjmp stuffDelay + rjmp stuffN2Delay ;[06] after ror, C bit is reliably clear +doExorN2: + eor x1, x2 ;[04] [12] + ldi x4, 6 ;[05] [13] +commonN2: + nop ;[06] [14] + subi cnt, 171 ;[07] [15] trick: (3 * 171) & 0xff = 1 + out USBOUT, x1 ;[08] [16] <--- set bit + brcs txBitloop ;[09] [25] [41] + +stuff6Delay: + ror shift ;[42] [50] + brcc doExor6 ;[43] + subi x4, 1 ;[44] + brne common6 ;[45] + lsl shift ;[46] compensate ror after rjmp stuffDelay + nop ;[47] stuffing consists of just waiting 8 cycles + rjmp stuff6Delay ;[48] after ror, C bit is reliably clear +doExor6: + eor x1, x2 ;[45] [53] + ldi x4, 6 ;[46] +common6: +stuff7Delay: + ror shift ;[47] [55] + out USBOUT, x1 ;[48] <--- set bit + brcc doExor7 ;[49] + subi x4, 1 ;[50] + brne common7 ;[51] + lsl shift ;[52] compensate ror after rjmp stuffDelay + rjmp stuff7Delay ;[53] after ror, C bit is reliably clear +doExor7: + eor x1, x2 ;[51] [59] + ldi x4, 6 ;[52] +common7: + ld shift, y+ ;[53] + tst cnt ;[55] + out USBOUT, x1 ;[56] <--- set bit + brne txByteLoop ;[57] + +;make SE0: + cbr x1, USBMASK ;[58] prepare SE0 [spec says EOP may be 15 to 18 cycles] + lds x2, usbNewDeviceAddr;[59] + lsl x2 ;[61] we compare with left shifted address + subi YL, 2 + 20 ;[62] Only assign address on data packets, not ACK/NAK in x3 + sbci YH, 0 ;[63] + out USBOUT, x1 ;[00] <-- out SE0 -- from now 2 bits = 16 cycles until bus idle +;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: +;set address only after data packet was sent, not after handshake + breq skipAddrAssign ;[01] + sts usbDeviceAddr, x2 ; if not skipped: SE0 is one cycle longer +skipAddrAssign: +;end of usbDeviceAddress transfer + ldi x2, 1< 12.5625 MHz +max frequency: 69.286 cycles for 8 bit -> 12.99 MHz +nominal frequency: 12.77 MHz ( = sqrt(min * max)) + +sampling positions: (next even number in range [+/- 0.5]) +cycle index range: 0 ... 66 +bits: +.5, 8.875, 17.25, 25.625, 34, 42.375, 50.75, 59.125 +[0/1], [9], [17], [25/+26], [34], [+42/43], [51], [59] + +bit number: 0 1 2 3 4 5 6 7 +spare cycles 1 2 1 2 1 1 1 0 + +operations to perform: duration cycle + ---------------- + eor fix, shift 1 -> 00 + andi phase, USBMASK 1 -> 08 + breq se0 1 -> 16 (moved to 11) + st y+, data 2 -> 24, 25 + mov data, fix 1 -> 33 + ser data 1 -> 41 + subi cnt, 1 1 -> 49 + brcs overflow 1 -> 50 + +layout of samples and operations: +[##] = sample bit +<##> = sample phase +*##* = operation + +0: *00* [01] 02 03 04 <05> 06 07 +1: *08* [09] 10 11 12 <13> 14 15 *16* +2: [17] 18 19 20 <21> 22 23 +3: *24* *25* [26] 27 28 29 <30> 31 32 +4: *33* [34] 35 36 37 <38> 39 40 +5: *41* [42] 43 44 45 <46> 47 48 +6: *49* *50* [51] 52 53 54 <55> 56 57 58 +7: [59] 60 61 62 <63> 64 65 66 +*****************************************************************************/ + +/* we prefer positive expressions (do if condition) instead of negative + * (skip if condition), therefore use defines for skip instructions: + */ +#define ifioclr sbis +#define ifioset sbic +#define ifrclr sbrs +#define ifrset sbrc + +/* The registers "fix" and "data" swap their meaning during the loop. Use + * defines to keep their name constant. + */ +#define fix x2 +#define data x1 +#undef phase /* phase has a default definition to x4 */ +#define phase x3 + + +USB_INTR_VECTOR: +;order of registers pushed: YL, SREG [sofError], YH, shift, x1, x2, x3, cnt, r0 + push YL ;2 push only what is necessary to sync with edge ASAP + in YL, SREG ;1 + push YL ;2 +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +;---------------------------------------------------------------------------- +;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +;sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +waitForK: +;The following code results in a sampling window of 1/4 bit which meets the spec. + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS ;[0] + rjmp foundK ;[1] +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError + +foundK: +;{3, 5} after falling D- edge, average delay: 4 cycles [we want 4 for center sampling] +;we have 1 bit time for setup purposes, then sample again. Numbers in brackets +;are cycles from center of first sync (double K) bit after the instruction + push YH ;[2] + lds YL, usbInputBufOffset;[4] + clr YH ;[6] + subi YL, lo8(-(usbRxBuf));[7] + sbci YH, hi8(-(usbRxBuf));[8] + + sbis USBIN, USBMINUS ;[9] we want two bits K [we want to sample at 8 + 4 - 1.5 = 10.5] + rjmp haveTwoBitsK ;[10] + pop YH ;[11] undo the push from before + rjmp waitForK ;[13] this was not the end of sync, retry +haveTwoBitsK: +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- +#define fix x2 +#define data x1 + + push shift ;[12] + push x1 ;[14] + push x2 ;[16] + ldi shift, 0x80 ;[18] prevent bit-unstuffing but init low bits to 0 + ifioset USBIN, USBMINUS ;[19] [01] <--- bit 0 [10.5 + 8 = 18.5] + ori shift, 1<<0 ;[02] + push x3 ;[03] + push cnt ;[05] + push r0 ;[07] + ifioset USBIN, USBMINUS ;[09] <--- bit 1 + ori shift, 1<<1 ;[10] + ser fix ;[11] + ldi cnt, USB_BUFSIZE ;[12] + mov data, shift ;[13] + lsl shift ;[14] + nop2 ;[15] + ifioset USBIN, USBMINUS ;[17] <--- bit 2 + ori data, 3<<2 ;[18] store in bit 2 AND bit 3 + eor shift, data ;[19] do nrzi decoding + andi data, 1<<3 ;[20] + in phase, USBIN ;[21] <- phase + brne jumpToEntryAfterSet ;[22] if USBMINS at bit 3 was 1 + nop ;[23] + rjmp entryAfterClr ;[24] +jumpToEntryAfterSet: + rjmp entryAfterSet ;[24] + +;---------------------------------------------------------------------------- +; Receiver loop (numbers in brackets are cycles within byte after instr) +;---------------------------------------------------------------------------- +#undef fix +#define fix x1 +#undef data +#define data x2 + +bit7IsSet: + ifrclr phase, USBMINUS ;[62] check phase only if D- changed + lpm ;[63] + in phase, USBIN ;[64] <- phase (one cycle too late) + ori shift, 1 << 7 ;[65] + nop ;[66] +;;;;rjmp bit0AfterSet ; -> [00] == [67] moved block up to save jump +bit0AfterSet: + eor fix, shift ;[00] +#undef fix +#define fix x2 +#undef data +#define data x1 /* we now have result in data, fix is reset to 0xff */ + ifioclr USBIN, USBMINUS ;[01] <--- sample 0 + rjmp bit0IsClr ;[02] + andi shift, ~(7 << 0) ;[03] + breq unstuff0s ;[04] + in phase, USBIN ;[05] <- phase + rjmp bit1AfterSet ;[06] +unstuff0s: + in phase, USBIN ;[06] <- phase (one cycle too late) + andi fix, ~(1 << 0) ;[07] + ifioclr USBIN, USBMINUS ;[00] + ifioset USBIN, USBPLUS ;[01] + rjmp bit0IsClr ;[02] executed if first expr false or second true +se0AndStore: ; executed only if both bits 0 + st y+, x1 ;[15/17] cycles after start of byte + rjmp se0 ;[17/19] + +bit0IsClr: + ifrset phase, USBMINUS ;[04] check phase only if D- changed + lpm ;[05] + in phase, USBIN ;[06] <- phase (one cycle too late) + ori shift, 1 << 0 ;[07] +bit1AfterClr: + andi phase, USBMASK ;[08] + ifioset USBIN, USBMINUS ;[09] <--- sample 1 + rjmp bit1IsSet ;[10] + breq se0AndStore ;[11] if D- was 0 in bits 0 AND 1 and D+ was 0 in between, we have SE0 + andi shift, ~(7 << 1) ;[12] + in phase, USBIN ;[13] <- phase + breq unstuff1c ;[14] + rjmp bit2AfterClr ;[15] +unstuff1c: + andi fix, ~(1 << 1) ;[16] + nop2 ;[08] + nop2 ;[10] +bit1IsSet: + ifrclr phase, USBMINUS ;[12] check phase only if D- changed + lpm ;[13] + in phase, USBIN ;[14] <- phase (one cycle too late) + ori shift, 1 << 1 ;[15] + nop ;[16] +bit2AfterSet: + ifioclr USBIN, USBMINUS ;[17] <--- sample 2 + rjmp bit2IsClr ;[18] + andi shift, ~(7 << 2) ;[19] + breq unstuff2s ;[20] + in phase, USBIN ;[21] <- phase + rjmp bit3AfterSet ;[22] +unstuff2s: + in phase, USBIN ;[22] <- phase (one cycle too late) + andi fix, ~(1 << 2) ;[23] + nop2 ;[16] + nop2 ;[18] +bit2IsClr: + ifrset phase, USBMINUS ;[20] check phase only if D- changed + lpm ;[21] + in phase, USBIN ;[22] <- phase (one cycle too late) + ori shift, 1 << 2 ;[23] +bit3AfterClr: + st y+, data ;[24] +entryAfterClr: + ifioset USBIN, USBMINUS ;[26] <--- sample 3 + rjmp bit3IsSet ;[27] + andi shift, ~(7 << 3) ;[28] + breq unstuff3c ;[29] + in phase, USBIN ;[30] <- phase + rjmp bit4AfterClr ;[31] +unstuff3c: + in phase, USBIN ;[31] <- phase (one cycle too late) + andi fix, ~(1 << 3) ;[32] + nop2 ;[25] + nop2 ;[27] +bit3IsSet: + ifrclr phase, USBMINUS ;[29] check phase only if D- changed + lpm ;[30] + in phase, USBIN ;[31] <- phase (one cycle too late) + ori shift, 1 << 3 ;[32] +bit4AfterSet: + mov data, fix ;[33] undo this move by swapping defines +#undef fix +#define fix x1 +#undef data +#define data x2 + ifioclr USBIN, USBMINUS ;[34] <--- sample 4 + rjmp bit4IsClr ;[35] + andi shift, ~(7 << 4) ;[36] + breq unstuff4s ;[37] + in phase, USBIN ;[38] <- phase + rjmp bit5AfterSet ;[39] +unstuff4s: + in phase, USBIN ;[39] <- phase (one cycle too late) + andi fix, ~(1 << 4) ;[40] + nop2 ;[33] + nop2 ;[35] +bit4IsClr: + ifrset phase, USBMINUS ;[37] check phase only if D- changed + lpm ;[38] + in phase, USBIN ;[39] <- phase (one cycle too late) + ori shift, 1 << 4 ;[40] +bit5AfterClr: + ser data ;[41] + ifioset USBIN, USBMINUS ;[42] <--- sample 5 + rjmp bit5IsSet ;[43] + andi shift, ~(7 << 5) ;[44] + breq unstuff5c ;[45] + in phase, USBIN ;[46] <- phase + rjmp bit6AfterClr ;[47] +unstuff5c: + in phase, USBIN ;[47] <- phase (one cycle too late) + andi fix, ~(1 << 5) ;[48] + nop2 ;[41] + nop2 ;[43] +bit5IsSet: + ifrclr phase, USBMINUS ;[45] check phase only if D- changed + lpm ;[46] + in phase, USBIN ;[47] <- phase (one cycle too late) + ori shift, 1 << 5 ;[48] +bit6AfterSet: + subi cnt, 1 ;[49] + brcs jumpToOverflow ;[50] + ifioclr USBIN, USBMINUS ;[51] <--- sample 6 + rjmp bit6IsClr ;[52] + andi shift, ~(3 << 6) ;[53] + cpi shift, 2 ;[54] + in phase, USBIN ;[55] <- phase + brlt unstuff6s ;[56] + rjmp bit7AfterSet ;[57] + +jumpToOverflow: + rjmp overflow + +unstuff6s: + andi fix, ~(1 << 6) ;[50] + lpm ;[51] +bit6IsClr: + ifrset phase, USBMINUS ;[54] check phase only if D- changed + lpm ;[55] + in phase, USBIN ;[56] <- phase (one cycle too late) + ori shift, 1 << 6 ;[57] + nop ;[58] +bit7AfterClr: + ifioset USBIN, USBMINUS ;[59] <--- sample 7 + rjmp bit7IsSet ;[60] + andi shift, ~(1 << 7) ;[61] + cpi shift, 4 ;[62] + in phase, USBIN ;[63] <- phase + brlt unstuff7c ;[64] + rjmp bit0AfterClr ;[65] -> [00] == [67] +unstuff7c: + andi fix, ~(1 << 7) ;[58] + nop ;[59] + rjmp bit7IsSet ;[60] + +bit7IsClr: + ifrset phase, USBMINUS ;[62] check phase only if D- changed + lpm ;[63] + in phase, USBIN ;[64] <- phase (one cycle too late) + ori shift, 1 << 7 ;[65] + nop ;[66] +;;;;rjmp bit0AfterClr ; -> [00] == [67] moved block up to save jump +bit0AfterClr: + eor fix, shift ;[00] +#undef fix +#define fix x2 +#undef data +#define data x1 /* we now have result in data, fix is reset to 0xff */ + ifioset USBIN, USBMINUS ;[01] <--- sample 0 + rjmp bit0IsSet ;[02] + andi shift, ~(7 << 0) ;[03] + breq unstuff0c ;[04] + in phase, USBIN ;[05] <- phase + rjmp bit1AfterClr ;[06] +unstuff0c: + in phase, USBIN ;[06] <- phase (one cycle too late) + andi fix, ~(1 << 0) ;[07] + ifioclr USBIN, USBMINUS ;[00] + ifioset USBIN, USBPLUS ;[01] + rjmp bit0IsSet ;[02] executed if first expr false or second true + rjmp se0AndStore ;[03] executed only if both bits 0 +bit0IsSet: + ifrclr phase, USBMINUS ;[04] check phase only if D- changed + lpm ;[05] + in phase, USBIN ;[06] <- phase (one cycle too late) + ori shift, 1 << 0 ;[07] +bit1AfterSet: + andi shift, ~(7 << 1) ;[08] compensated by "ori shift, 1<<1" if bit1IsClr + ifioclr USBIN, USBMINUS ;[09] <--- sample 1 + rjmp bit1IsClr ;[10] + breq unstuff1s ;[11] + nop2 ;[12] do not check for SE0 if bit 0 was 1 + in phase, USBIN ;[14] <- phase (one cycle too late) + rjmp bit2AfterSet ;[15] +unstuff1s: + in phase, USBIN ;[13] <- phase + andi fix, ~(1 << 1) ;[14] + lpm ;[07] + nop2 ;[10] +bit1IsClr: + ifrset phase, USBMINUS ;[12] check phase only if D- changed + lpm ;[13] + in phase, USBIN ;[14] <- phase (one cycle too late) + ori shift, 1 << 1 ;[15] + nop ;[16] +bit2AfterClr: + ifioset USBIN, USBMINUS ;[17] <--- sample 2 + rjmp bit2IsSet ;[18] + andi shift, ~(7 << 2) ;[19] + breq unstuff2c ;[20] + in phase, USBIN ;[21] <- phase + rjmp bit3AfterClr ;[22] +unstuff2c: + in phase, USBIN ;[22] <- phase (one cycle too late) + andi fix, ~(1 << 2) ;[23] + nop2 ;[16] + nop2 ;[18] +bit2IsSet: + ifrclr phase, USBMINUS ;[20] check phase only if D- changed + lpm ;[21] + in phase, USBIN ;[22] <- phase (one cycle too late) + ori shift, 1 << 2 ;[23] +bit3AfterSet: + st y+, data ;[24] +entryAfterSet: + ifioclr USBIN, USBMINUS ;[26] <--- sample 3 + rjmp bit3IsClr ;[27] + andi shift, ~(7 << 3) ;[28] + breq unstuff3s ;[29] + in phase, USBIN ;[30] <- phase + rjmp bit4AfterSet ;[31] +unstuff3s: + in phase, USBIN ;[31] <- phase (one cycle too late) + andi fix, ~(1 << 3) ;[32] + nop2 ;[25] + nop2 ;[27] +bit3IsClr: + ifrset phase, USBMINUS ;[29] check phase only if D- changed + lpm ;[30] + in phase, USBIN ;[31] <- phase (one cycle too late) + ori shift, 1 << 3 ;[32] +bit4AfterClr: + mov data, fix ;[33] undo this move by swapping defines +#undef fix +#define fix x1 +#undef data +#define data x2 + ifioset USBIN, USBMINUS ;[34] <--- sample 4 + rjmp bit4IsSet ;[35] + andi shift, ~(7 << 4) ;[36] + breq unstuff4c ;[37] + in phase, USBIN ;[38] <- phase + rjmp bit5AfterClr ;[39] +unstuff4c: + in phase, USBIN ;[39] <- phase (one cycle too late) + andi fix, ~(1 << 4) ;[40] + nop2 ;[33] + nop2 ;[35] +bit4IsSet: + ifrclr phase, USBMINUS ;[37] check phase only if D- changed + lpm ;[38] + in phase, USBIN ;[39] <- phase (one cycle too late) + ori shift, 1 << 4 ;[40] +bit5AfterSet: + ser data ;[41] + ifioclr USBIN, USBMINUS ;[42] <--- sample 5 + rjmp bit5IsClr ;[43] + andi shift, ~(7 << 5) ;[44] + breq unstuff5s ;[45] + in phase, USBIN ;[46] <- phase + rjmp bit6AfterSet ;[47] +unstuff5s: + in phase, USBIN ;[47] <- phase (one cycle too late) + andi fix, ~(1 << 5) ;[48] + nop2 ;[41] + nop2 ;[43] +bit5IsClr: + ifrset phase, USBMINUS ;[45] check phase only if D- changed + lpm ;[46] + in phase, USBIN ;[47] <- phase (one cycle too late) + ori shift, 1 << 5 ;[48] +bit6AfterClr: + subi cnt, 1 ;[49] + brcs overflow ;[50] + ifioset USBIN, USBMINUS ;[51] <--- sample 6 + rjmp bit6IsSet ;[52] + andi shift, ~(3 << 6) ;[53] + cpi shift, 2 ;[54] + in phase, USBIN ;[55] <- phase + brlt unstuff6c ;[56] + rjmp bit7AfterClr ;[57] +unstuff6c: + andi fix, ~(1 << 6) ;[50] + lpm ;[51] +bit6IsSet: + ifrclr phase, USBMINUS ;[54] check phase only if D- changed + lpm ;[55] + in phase, USBIN ;[56] <- phase (one cycle too late) + ori shift, 1 << 6 ;[57] +bit7AfterSet: + ifioclr USBIN, USBMINUS ;[59] <--- sample 7 + rjmp bit7IsClr ;[60] + andi shift, ~(1 << 7) ;[61] + cpi shift, 4 ;[62] + in phase, USBIN ;[63] <- phase + brlt unstuff7s ;[64] + rjmp bit0AfterSet ;[65] -> [00] == [67] +unstuff7s: + andi fix, ~(1 << 7) ;[58] + nop ;[59] + rjmp bit7IsClr ;[60] + +macro POP_STANDARD ; 14 cycles + pop r0 + pop cnt + pop x3 + pop x2 + pop x1 + pop shift + pop YH + endm +macro POP_RETI ; 5 cycles + pop YL + out SREG, YL + pop YL + endm + +#include "asmcommon.inc" + +;---------------------------------------------------------------------------- +; Transmitting data +;---------------------------------------------------------------------------- + +txByteLoop: +txBitloop: +stuffN1Delay: ; [03] + ror shift ;[-5] [11] [63] + brcc doExorN1 ;[-4] [64] + subi x3, 1 ;[-3] + brne commonN1 ;[-2] + lsl shift ;[-1] compensate ror after rjmp stuffDelay + nop ;[00] stuffing consists of just waiting 8 cycles + rjmp stuffN1Delay ;[01] after ror, C bit is reliably clear + +sendNakAndReti: + ldi cnt, USBPID_NAK ;[-19] + rjmp sendCntAndReti ;[-18] +sendAckAndReti: + ldi cnt, USBPID_ACK ;[-17] +sendCntAndReti: + mov r0, cnt ;[-16] + ldi YL, 0 ;[-15] R0 address is 0 + ldi YH, 0 ;[-14] + ldi cnt, 2 ;[-13] +; rjmp usbSendAndReti fallthrough + +; USB spec says: +; idle = J +; J = (D+ = 0), (D- = 1) or USBOUT = 0x01 +; K = (D+ = 1), (D- = 0) or USBOUT = 0x02 +; Spec allows 7.5 bit times from EOP to SOP for replies (= 60 cycles) + +;usbSend: +;pointer to data in 'Y' +;number of bytes in 'cnt' -- including sync byte +;uses: x1...x3, shift, cnt, Y [x1 = mirror USBOUT, x2 = USBMASK, x3 = bitstuff cnt] +;Numbers in brackets are time since first bit of sync pattern is sent (start of instruction) +usbSendAndReti: + in x2, USBDDR ;[-10] 10 cycles until SOP + ori x2, USBMASK ;[-9] + sbi USBOUT, USBMINUS ;[-8] prepare idle state; D+ and D- must have been 0 (no pullups) + out USBDDR, x2 ;[-6] <--- acquire bus + in x1, USBOUT ;[-5] port mirror for tx loop + ldi shift, 0x40 ;[-4] sync byte is first byte sent (we enter loop after ror) + ldi x2, USBMASK ;[-3] +doExorN1: + eor x1, x2 ;[-2] [06] [62] + ldi x3, 6 ;[-1] [07] [63] +commonN1: +stuffN2Delay: + out USBOUT, x1 ;[00] [08] [64] <--- set bit + ror shift ;[01] + brcc doExorN2 ;[02] + subi x3, 1 ;[03] + brne commonN2 ;[04] + lsl shift ;[05] compensate ror after rjmp stuffDelay + rjmp stuffN2Delay ;[06] after ror, C bit is reliably clear +doExorN2: + eor x1, x2 ;[04] [12] + ldi x3, 6 ;[05] [13] +commonN2: + nop2 ;[06] [14] + subi cnt, 171 ;[08] [16] trick: (3 * 171) & 0xff = 1 + out USBOUT, x1 ;[09] [17] <--- set bit + brcs txBitloop ;[10] [27] [44] + +stuff6Delay: + ror shift ;[45] [53] + brcc doExor6 ;[46] + subi x3, 1 ;[47] + brne common6 ;[48] + lsl shift ;[49] compensate ror after rjmp stuffDelay + nop ;[50] stuffing consists of just waiting 8 cycles + rjmp stuff6Delay ;[51] after ror, C bit is reliably clear +doExor6: + eor x1, x2 ;[48] [56] + ldi x3, 6 ;[49] +common6: +stuff7Delay: + ror shift ;[50] [58] + out USBOUT, x1 ;[51] <--- set bit + brcc doExor7 ;[52] + subi x3, 1 ;[53] + brne common7 ;[54] + lsl shift ;[55] compensate ror after rjmp stuffDelay + rjmp stuff7Delay ;[56] after ror, C bit is reliably clear +doExor7: + eor x1, x2 ;[54] [62] + ldi x3, 6 ;[55] +common7: + ld shift, y+ ;[56] + nop ;[58] + tst cnt ;[59] + out USBOUT, x1 ;[60] [00]<--- set bit + brne txByteLoop ;[61] [01] +;make SE0: + cbr x1, USBMASK ;[02] prepare SE0 [spec says EOP may be 15 to 18 cycles] + lds x2, usbNewDeviceAddr;[03] + lsl x2 ;[05] we compare with left shifted address + subi YL, 2 + 0 ;[06] Only assign address on data packets, not ACK/NAK in r0 + sbci YH, 0 ;[07] + out USBOUT, x1 ;[00] <-- out SE0 -- from now 2 bits = 16 cycles until bus idle +;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: +;set address only after data packet was sent, not after handshake + breq skipAddrAssign ;[01] + sts usbDeviceAddr, x2 ; if not skipped: SE0 is one cycle longer +skipAddrAssign: +;end of usbDeviceAddress transfer + ldi x2, 1< 0) + echo "$s\n"; + } +} + +function printBit($isAfterSet, $bitNum) +{ + ob_start(); + if($isAfterSet){ +?> + ifioclr USBIN, USBMINUS ;[00] <--- sample + rjmp bit#IsClr ;[01] + andi shift, ~(7 << #) ;[02] + breq unstuff#s ;[03] + in phase, USBIN ;[04] <- phase + rjmp bit@AfterSet ;[05] +unstuff#s: + in phase, USBIN ;[05] <- phase (one cycle too late) + andi fix, ~(1 << #) ;[06] + nop2 ;[-1] + nop2 ;[01] +bit#IsClr: + ifrset phase, USBMINUS ;[03] check phase only if D- changed + lpm ;[04] + in phase, USBIN ;[05] <- phase (one cycle too late) + ori shift, 1 << # ;[06] + + ifioset USBIN, USBMINUS ;[00] <--- sample + rjmp bit#IsSet ;[01] + andi shift, ~(7 << #) ;[02] + breq unstuff#c ;[03] + in phase, USBIN ;[04] <- phase + rjmp bit@AfterClr ;[05] +unstuff#c: + in phase, USBIN ;[05] <- phase (one cycle too late) + andi fix, ~(1 << #) ;[06] + nop2 ;[-1] + nop2 ;[01] +bit#IsSet: + ifrclr phase, USBMINUS ;[03] check phase only if D- changed + lpm ;[04] + in phase, USBIN ;[05] <- phase (one cycle too late) + ori shift, 1 << # ;[06] + +*****************************************************************************/ diff --git a/classic/fw/usbdrv/usbdrvasm15.inc b/classic/fw/usbdrv/usbdrvasm15.inc new file mode 100644 index 0000000..33bcf0e --- /dev/null +++ b/classic/fw/usbdrv/usbdrvasm15.inc @@ -0,0 +1,422 @@ +/* Name: usbdrvasm15.inc + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: contributed by V. Bosch + * Creation Date: 2007-08-06 + * Tabsize: 4 + * Copyright: (c) 2007 by OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +/* Do not link this file! Link usbdrvasm.S instead, which includes the + * appropriate implementation! + */ + +/* +General Description: +This file is the 15 MHz version of the asssembler part of the USB driver. It +requires a 15 MHz crystal (not a ceramic resonator and not a calibrated RC +oscillator). + +See usbdrv.h for a description of the entire driver. + +Since almost all of this code is timing critical, don't change unless you +really know what you are doing! Many parts require not only a maximum number +of CPU cycles, but even an exact number of cycles! +*/ + +;max stack usage: [ret(2), YL, SREG, YH, bitcnt, shift, x1, x2, x3, x4, cnt] = 12 bytes +;nominal frequency: 15 MHz -> 10.0 cycles per bit, 80.0 cycles per byte +; Numbers in brackets are clocks counted from center of last sync bit +; when instruction starts + +;---------------------------------------------------------------------------- +; order of registers pushed: +; YL, SREG [sofError] YH, shift, x1, x2, x3, bitcnt, cnt, x4 +;---------------------------------------------------------------------------- +USB_INTR_VECTOR: + push YL ;2 push only what is necessary to sync with edge ASAP + in YL, SREG ;1 + push YL ;2 +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +; +; sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +; sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +;------------------------------------------------------------------------------- +; The following code results in a sampling window of < 1/4 bit +; which meets the spec. +;------------------------------------------------------------------------------- +waitForK: ;- + sbis USBIN, USBMINUS ;1 [00] <-- sample + rjmp foundK ;2 [01] + sbis USBIN, USBMINUS ; <-- sample + rjmp foundK + sbis USBIN, USBMINUS ; <-- sample + rjmp foundK + sbis USBIN, USBMINUS ; <-- sample + rjmp foundK + sbis USBIN, USBMINUS ; <-- sample + rjmp foundK + sbis USBIN, USBMINUS ; <-- sample + rjmp foundK +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError +;------------------------------------------------------------------------------ +; {3, 5} after falling D- edge, average delay: 4 cycles [we want 5 for +; center sampling] +; we have 1 bit time for setup purposes, then sample again. +; Numbers in brackets are cycles from center of first sync (double K) +; bit after the instruction +;------------------------------------------------------------------------------ +foundK: ;- [02] + lds YL, usbInputBufOffset;2 [03+04] tx loop + push YH ;2 [05+06] + clr YH ;1 [07] + subi YL, lo8(-(usbRxBuf)) ;1 [08] [rx loop init] + sbci YH, hi8(-(usbRxBuf)) ;1 [09] [rx loop init] + push shift ;2 [10+11] + ser shift ;1 [12] + sbis USBIN, USBMINUS ;1 [-1] [13] <--sample:we want two bits K (sample 1 cycle too early) + rjmp haveTwoBitsK ;2 [00] [14] + pop shift ;2 [15+16] undo the push from before + pop YH ;2 [17+18] undo the push from before + rjmp waitForK ;2 [19+20] this was not the end of sync, retry +; The entire loop from waitForK until rjmp waitForK above must not exceed two +; bit times (= 20 cycles). + +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- +haveTwoBitsK: ;- [01] + push x1 ;2 [02+03] + push x2 ;2 [04+05] + push x3 ;2 [06+07] + push bitcnt ;2 [08+09] + in x1, USBIN ;1 [00] [10] <-- sample bit 0 + bst x1, USBMINUS ;1 [01] + bld shift, 0 ;1 [02] + push cnt ;2 [03+04] + ldi cnt, USB_BUFSIZE ;1 [05] + push x4 ;2 [06+07] tx loop + rjmp rxLoop ;2 [08] +;---------------------------------------------------------------------------- +; Receiver loop (numbers in brackets are cycles within byte after instr) +;---------------------------------------------------------------------------- +unstuff0: ;- [07] (branch taken) + andi x3, ~0x01 ;1 [08] + mov x1, x2 ;1 [09] x2 contains last sampled (stuffed) bit + in x2, USBIN ;1 [00] [10] <-- sample bit 1 again + andi x2, USBMASK ;1 [01] + breq se0Hop ;1 [02] SE0 check for bit 1 + ori shift, 0x01 ;1 [03] 0b00000001 + nop ;1 [04] + rjmp didUnstuff0 ;2 [05] +;----------------------------------------------------- +unstuff1: ;- [05] (branch taken) + mov x2, x1 ;1 [06] x1 contains last sampled (stuffed) bit + andi x3, ~0x02 ;1 [07] + ori shift, 0x02 ;1 [08] 0b00000010 + nop ;1 [09] + in x1, USBIN ;1 [00] [10] <-- sample bit 2 again + andi x1, USBMASK ;1 [01] + breq se0Hop ;1 [02] SE0 check for bit 2 + rjmp didUnstuff1 ;2 [03] +;----------------------------------------------------- +unstuff2: ;- [05] (branch taken) + andi x3, ~0x04 ;1 [06] + ori shift, 0x04 ;1 [07] 0b00000100 + mov x1, x2 ;1 [08] x2 contains last sampled (stuffed) bit + nop ;1 [09] + in x2, USBIN ;1 [00] [10] <-- sample bit 3 + andi x2, USBMASK ;1 [01] + breq se0Hop ;1 [02] SE0 check for bit 3 + rjmp didUnstuff2 ;2 [03] +;----------------------------------------------------- +unstuff3: ;- [00] [10] (branch taken) + in x2, USBIN ;1 [01] [11] <-- sample stuffed bit 3 one cycle too late + andi x2, USBMASK ;1 [02] + breq se0Hop ;1 [03] SE0 check for stuffed bit 3 + andi x3, ~0x08 ;1 [04] + ori shift, 0x08 ;1 [05] 0b00001000 + rjmp didUnstuff3 ;2 [06] +;---------------------------------------------------------------------------- +; extra jobs done during bit interval: +; +; bit 0: store, clear [SE0 is unreliable here due to bit dribbling in hubs], +; overflow check, jump to the head of rxLoop +; bit 1: SE0 check +; bit 2: SE0 check, recovery from delay [bit 0 tasks took too long] +; bit 3: SE0 check, recovery from delay [bit 0 tasks took too long] +; bit 4: SE0 check, none +; bit 5: SE0 check, none +; bit 6: SE0 check, none +; bit 7: SE0 check, reconstruct: x3 is 0 at bit locations we changed, 1 at others +;---------------------------------------------------------------------------- +rxLoop: ;- [09] + in x2, USBIN ;1 [00] [10] <-- sample bit 1 (or possibly bit 0 stuffed) + andi x2, USBMASK ;1 [01] + brne SkipSe0Hop ;1 [02] +se0Hop: ;- [02] + rjmp se0 ;2 [03] SE0 check for bit 1 +SkipSe0Hop: ;- [03] + ser x3 ;1 [04] + andi shift, 0xf9 ;1 [05] 0b11111001 + breq unstuff0 ;1 [06] +didUnstuff0: ;- [06] + eor x1, x2 ;1 [07] + bst x1, USBMINUS ;1 [08] + bld shift, 1 ;1 [09] + in x1, USBIN ;1 [00] [10] <-- sample bit 2 (or possibly bit 1 stuffed) + andi x1, USBMASK ;1 [01] + breq se0Hop ;1 [02] SE0 check for bit 2 + andi shift, 0xf3 ;1 [03] 0b11110011 + breq unstuff1 ;1 [04] do remaining work for bit 1 +didUnstuff1: ;- [04] + eor x2, x1 ;1 [05] + bst x2, USBMINUS ;1 [06] + bld shift, 2 ;1 [07] + nop2 ;2 [08+09] + in x2, USBIN ;1 [00] [10] <-- sample bit 3 (or possibly bit 2 stuffed) + andi x2, USBMASK ;1 [01] + breq se0Hop ;1 [02] SE0 check for bit 3 + andi shift, 0xe7 ;1 [03] 0b11100111 + breq unstuff2 ;1 [04] +didUnstuff2: ;- [04] + eor x1, x2 ;1 [05] + bst x1, USBMINUS ;1 [06] + bld shift, 3 ;1 [07] +didUnstuff3: ;- [07] + andi shift, 0xcf ;1 [08] 0b11001111 + breq unstuff3 ;1 [09] + in x1, USBIN ;1 [00] [10] <-- sample bit 4 + andi x1, USBMASK ;1 [01] + breq se0Hop ;1 [02] SE0 check for bit 4 + eor x2, x1 ;1 [03] + bst x2, USBMINUS ;1 [04] + bld shift, 4 ;1 [05] +didUnstuff4: ;- [05] + andi shift, 0x9f ;1 [06] 0b10011111 + breq unstuff4 ;1 [07] + nop2 ;2 [08+09] + in x2, USBIN ;1 [00] [10] <-- sample bit 5 + andi x2, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for bit 5 + eor x1, x2 ;1 [03] + bst x1, USBMINUS ;1 [04] + bld shift, 5 ;1 [05] +didUnstuff5: ;- [05] + andi shift, 0x3f ;1 [06] 0b00111111 + breq unstuff5 ;1 [07] + nop2 ;2 [08+09] + in x1, USBIN ;1 [00] [10] <-- sample bit 6 + andi x1, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for bit 6 + eor x2, x1 ;1 [03] + bst x2, USBMINUS ;1 [04] + bld shift, 6 ;1 [05] +didUnstuff6: ;- [05] + cpi shift, 0x02 ;1 [06] 0b00000010 + brlo unstuff6 ;1 [07] + nop2 ;2 [08+09] + in x2, USBIN ;1 [00] [10] <-- sample bit 7 + andi x2, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for bit 7 + eor x1, x2 ;1 [03] + bst x1, USBMINUS ;1 [04] + bld shift, 7 ;1 [05] +didUnstuff7: ;- [05] + cpi shift, 0x04 ;1 [06] 0b00000100 + brlo unstuff7 ;1 [07] + eor x3, shift ;1 [08] reconstruct: x3 is 0 at bit locations we changed, 1 at others + nop ;1 [09] + in x1, USBIN ;1 [00] [10] <-- sample bit 0 + st y+, x3 ;2 [01+02] store data + eor x2, x1 ;1 [03] + bst x2, USBMINUS ;1 [04] + bld shift, 0 ;1 [05] + subi cnt, 1 ;1 [06] + brcs overflow ;1 [07] + rjmp rxLoop ;2 [08] +;----------------------------------------------------- +unstuff4: ;- [08] + andi x3, ~0x10 ;1 [09] + in x1, USBIN ;1 [00] [10] <-- sample stuffed bit 4 + andi x1, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for stuffed bit 4 + ori shift, 0x10 ;1 [03] + rjmp didUnstuff4 ;2 [04] +;----------------------------------------------------- +unstuff5: ;- [08] + ori shift, 0x20 ;1 [09] + in x2, USBIN ;1 [00] [10] <-- sample stuffed bit 5 + andi x2, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for stuffed bit 5 + andi x3, ~0x20 ;1 [03] + rjmp didUnstuff5 ;2 [04] +;----------------------------------------------------- +unstuff6: ;- [08] + andi x3, ~0x40 ;1 [09] + in x1, USBIN ;1 [00] [10] <-- sample stuffed bit 6 + andi x1, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for stuffed bit 6 + ori shift, 0x40 ;1 [03] + rjmp didUnstuff6 ;2 [04] +;----------------------------------------------------- +unstuff7: ;- [08] + andi x3, ~0x80 ;1 [09] + in x2, USBIN ;1 [00] [10] <-- sample stuffed bit 7 + andi x2, USBMASK ;1 [01] + breq se0 ;1 [02] SE0 check for stuffed bit 7 + ori shift, 0x80 ;1 [03] + rjmp didUnstuff7 ;2 [04] + +macro POP_STANDARD ; 16 cycles + pop x4 + pop cnt + pop bitcnt + pop x3 + pop x2 + pop x1 + pop shift + pop YH + endm +macro POP_RETI ; 5 cycles + pop YL + out SREG, YL + pop YL + endm + +#include "asmcommon.inc" + +;--------------------------------------------------------------------------- +; USB spec says: +; idle = J +; J = (D+ = 0), (D- = 1) +; K = (D+ = 1), (D- = 0) +; Spec allows 7.5 bit times from EOP to SOP for replies +;--------------------------------------------------------------------------- +bitstuffN: ;- [04] + eor x1, x4 ;1 [05] + clr x2 ;1 [06] + nop ;1 [07] + rjmp didStuffN ;1 [08] +;--------------------------------------------------------------------------- +bitstuff6: ;- [04] + eor x1, x4 ;1 [05] + clr x2 ;1 [06] + rjmp didStuff6 ;1 [07] +;--------------------------------------------------------------------------- +bitstuff7: ;- [02] + eor x1, x4 ;1 [03] + clr x2 ;1 [06] + nop ;1 [05] + rjmp didStuff7 ;1 [06] +;--------------------------------------------------------------------------- +sendNakAndReti: ;- [-19] + ldi x3, USBPID_NAK ;1 [-18] + rjmp sendX3AndReti ;1 [-17] +;--------------------------------------------------------------------------- +sendAckAndReti: ;- [-17] + ldi cnt, USBPID_ACK ;1 [-16] +sendCntAndReti: ;- [-16] + mov x3, cnt ;1 [-15] +sendX3AndReti: ;- [-15] + ldi YL, 20 ;1 [-14] x3==r20 address is 20 + ldi YH, 0 ;1 [-13] + ldi cnt, 2 ;1 [-12] +; rjmp usbSendAndReti fallthrough +;--------------------------------------------------------------------------- +;usbSend: +;pointer to data in 'Y' +;number of bytes in 'cnt' -- including sync byte [range 2 ... 12] +;uses: x1...x4, btcnt, shift, cnt, Y +;Numbers in brackets are time since first bit of sync pattern is sent +;We need not to match the transfer rate exactly because the spec demands +;only 1.5% precision anyway. +usbSendAndReti: ;- [-13] 13 cycles until SOP + in x2, USBDDR ;1 [-12] + ori x2, USBMASK ;1 [-11] + sbi USBOUT, USBMINUS ;2 [-09-10] prepare idle state; D+ and D- must have been 0 (no pullups) + in x1, USBOUT ;1 [-08] port mirror for tx loop + out USBDDR, x2 ;1 [-07] <- acquire bus + ; need not init x2 (bitstuff history) because sync starts with 0 + ldi x4, USBMASK ;1 [-06] exor mask + ldi shift, 0x80 ;1 [-05] sync byte is first byte sent + ldi bitcnt, 6 ;1 [-04] +txBitLoop: ;- [-04] [06] + sbrs shift, 0 ;1 [-03] [07] + eor x1, x4 ;1 [-02] [08] + ror shift ;1 [-01] [09] +didStuffN: ;- [09] + out USBOUT, x1 ;1 [00] [10] <-- out N + ror x2 ;1 [01] + cpi x2, 0xfc ;1 [02] + brcc bitstuffN ;1 [03] + dec bitcnt ;1 [04] + brne txBitLoop ;1 [05] + sbrs shift, 0 ;1 [06] + eor x1, x4 ;1 [07] + ror shift ;1 [08] +didStuff6: ;- [08] + nop ;1 [09] + out USBOUT, x1 ;1 [00] [10] <-- out 6 + ror x2 ;1 [01] + cpi x2, 0xfc ;1 [02] + brcc bitstuff6 ;1 [03] + sbrs shift, 0 ;1 [04] + eor x1, x4 ;1 [05] + ror shift ;1 [06] + ror x2 ;1 [07] +didStuff7: ;- [07] + ldi bitcnt, 6 ;1 [08] + cpi x2, 0xfc ;1 [09] + out USBOUT, x1 ;1 [00] [10] <-- out 7 + brcc bitstuff7 ;1 [01] + ld shift, y+ ;2 [02+03] + dec cnt ;1 [04] + brne txBitLoop ;1 [05] +makeSE0: + cbr x1, USBMASK ;1 [06] prepare SE0 [spec says EOP may be 19 to 23 cycles] + lds x2, usbNewDeviceAddr;2 [07+08] + lsl x2 ;1 [09] we compare with left shifted address +;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: +;set address only after data packet was sent, not after handshake + out USBOUT, x1 ;1 [00] [10] <-- out SE0-- from now 2 bits==20 cycl. until bus idle + subi YL, 20 + 2 ;1 [01] Only assign address on data packets, not ACK/NAK in x3 + sbci YH, 0 ;1 [02] + breq skipAddrAssign ;1 [03] + sts usbDeviceAddr, x2 ;2 [04+05] if not skipped: SE0 is one cycle longer +;---------------------------------------------------------------------------- +;end of usbDeviceAddress transfer +skipAddrAssign: ;- [03/04] + ldi x2, 1< 10.6666666 cycles per bit, 85.333333333 cycles per byte +; Numbers in brackets are clocks counted from center of last sync bit +; when instruction starts + +USB_INTR_VECTOR: +;order of registers pushed: YL, SREG YH, [sofError], bitcnt, shift, x1, x2, x3, x4, cnt + push YL ;[-25] push only what is necessary to sync with edge ASAP + in YL, SREG ;[-23] + push YL ;[-22] + push YH ;[-20] +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +;---------------------------------------------------------------------------- +;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +;sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +waitForK: +;The following code results in a sampling window of < 1/4 bit which meets the spec. + sbis USBIN, USBMINUS ;[-15] + rjmp foundK ;[-14] + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError +foundK: ;[-12] +;{3, 5} after falling D- edge, average delay: 4 cycles [we want 5 for center sampling] +;we have 1 bit time for setup purposes, then sample again. Numbers in brackets +;are cycles from center of first sync (double K) bit after the instruction + push bitcnt ;[-12] +; [---] ;[-11] + lds YL, usbInputBufOffset;[-10] +; [---] ;[-9] + clr YH ;[-8] + subi YL, lo8(-(usbRxBuf));[-7] [rx loop init] + sbci YH, hi8(-(usbRxBuf));[-6] [rx loop init] + push shift ;[-5] +; [---] ;[-4] + ldi bitcnt, 0x55 ;[-3] [rx loop init] + sbis USBIN, USBMINUS ;[-2] we want two bits K (sample 2 cycles too early) + rjmp haveTwoBitsK ;[-1] + pop shift ;[0] undo the push from before + pop bitcnt ;[2] undo the push from before + rjmp waitForK ;[4] this was not the end of sync, retry +; The entire loop from waitForK until rjmp waitForK above must not exceed two +; bit times (= 21 cycles). + +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- +haveTwoBitsK: + push x1 ;[1] + push x2 ;[3] + push x3 ;[5] + ldi shift, 0 ;[7] + ldi x3, 1<<4 ;[8] [rx loop init] first sample is inverse bit, compensate that + push x4 ;[9] == leap + + in x1, USBIN ;[11] <-- sample bit 0 + andi x1, USBMASK ;[12] + bst x1, USBMINUS ;[13] + bld shift, 7 ;[14] + push cnt ;[15] + ldi leap, 0 ;[17] [rx loop init] + ldi cnt, USB_BUFSIZE;[18] [rx loop init] + rjmp rxbit1 ;[19] arrives at [21] + +;---------------------------------------------------------------------------- +; Receiver loop (numbers in brackets are cycles within byte after instr) +;---------------------------------------------------------------------------- + +; duration of unstuffing code should be 10.66666667 cycles. We adjust "leap" +; accordingly to approximate this value in the long run. + +unstuff6: + andi x2, USBMASK ;[03] + ori x3, 1<<6 ;[04] will not be shifted any more + andi shift, ~0x80;[05] + mov x1, x2 ;[06] sampled bit 7 is actually re-sampled bit 6 + subi leap, -1 ;[07] total duration = 11 bits -> subtract 1/3 + rjmp didUnstuff6 ;[08] + +unstuff7: + ori x3, 1<<7 ;[09] will not be shifted any more + in x2, USBIN ;[00] [10] re-sample bit 7 + andi x2, USBMASK ;[01] + andi shift, ~0x80;[02] + subi leap, 2 ;[03] total duration = 10 bits -> add 1/3 + rjmp didUnstuff7 ;[04] + +unstuffEven: + ori x3, 1<<6 ;[09] will be shifted right 6 times for bit 0 + in x1, USBIN ;[00] [10] + andi shift, ~0x80;[01] + andi x1, USBMASK ;[02] + breq se0 ;[03] + subi leap, -1 ;[04] total duration = 11 bits -> subtract 1/3 + nop2 ;[05] + rjmp didUnstuffE ;[06] + +unstuffOdd: + ori x3, 1<<5 ;[09] will be shifted right 4 times for bit 1 + in x2, USBIN ;[00] [10] + andi shift, ~0x80;[01] + andi x2, USBMASK ;[02] + breq se0 ;[03] + subi leap, -1 ;[04] total duration = 11 bits -> subtract 1/3 + nop2 ;[05] + rjmp didUnstuffO ;[06] + +rxByteLoop: + andi x1, USBMASK ;[03] + eor x2, x1 ;[04] + subi leap, 1 ;[05] + brpl skipLeap ;[06] + subi leap, -3 ;1 one leap cycle every 3rd byte -> 85 + 1/3 cycles per byte + nop ;1 +skipLeap: + subi x2, 1 ;[08] + ror shift ;[09] +didUnstuff6: + cpi shift, 0xfc ;[10] + in x2, USBIN ;[00] [11] <-- sample bit 7 + brcc unstuff6 ;[01] + andi x2, USBMASK ;[02] + eor x1, x2 ;[03] + subi x1, 1 ;[04] + ror shift ;[05] +didUnstuff7: + cpi shift, 0xfc ;[06] + brcc unstuff7 ;[07] + eor x3, shift ;[08] reconstruct: x3 is 1 at bit locations we changed, 0 at others + st y+, x3 ;[09] store data +rxBitLoop: + in x1, USBIN ;[00] [11] <-- sample bit 0/2/4 + andi x1, USBMASK ;[01] + eor x2, x1 ;[02] + andi x3, 0x3f ;[03] topmost two bits reserved for 6 and 7 + subi x2, 1 ;[04] + ror shift ;[05] + cpi shift, 0xfc ;[06] + brcc unstuffEven ;[07] +didUnstuffE: + lsr x3 ;[08] + lsr x3 ;[09] +rxbit1: + in x2, USBIN ;[00] [10] <-- sample bit 1/3/5 + andi x2, USBMASK ;[01] + breq se0 ;[02] + eor x1, x2 ;[03] + subi x1, 1 ;[04] + ror shift ;[05] + cpi shift, 0xfc ;[06] + brcc unstuffOdd ;[07] +didUnstuffO: + subi bitcnt, 0xab;[08] == addi 0x55, 0x55 = 0x100/3 + brcs rxBitLoop ;[09] + + subi cnt, 1 ;[10] + in x1, USBIN ;[00] [11] <-- sample bit 6 + brcc rxByteLoop ;[01] + rjmp overflow + +macro POP_STANDARD ; 14 cycles + pop cnt + pop x4 + pop x3 + pop x2 + pop x1 + pop shift + pop bitcnt + endm +macro POP_RETI ; 7 cycles + pop YH + pop YL + out SREG, YL + pop YL + endm + +#include "asmcommon.inc" + +; USB spec says: +; idle = J +; J = (D+ = 0), (D- = 1) +; K = (D+ = 1), (D- = 0) +; Spec allows 7.5 bit times from EOP to SOP for replies + +bitstuffN: + eor x1, x4 ;[5] + ldi x2, 0 ;[6] + nop2 ;[7] + nop ;[9] + out USBOUT, x1 ;[10] <-- out + rjmp didStuffN ;[0] + +bitstuff6: + eor x1, x4 ;[5] + ldi x2, 0 ;[6] Carry is zero due to brcc + rol shift ;[7] compensate for ror shift at branch destination + rjmp didStuff6 ;[8] + +bitstuff7: + ldi x2, 0 ;[2] Carry is zero due to brcc + rjmp didStuff7 ;[3] + + +sendNakAndReti: + ldi x3, USBPID_NAK ;[-18] + rjmp sendX3AndReti ;[-17] +sendAckAndReti: + ldi cnt, USBPID_ACK ;[-17] +sendCntAndReti: + mov x3, cnt ;[-16] +sendX3AndReti: + ldi YL, 20 ;[-15] x3==r20 address is 20 + ldi YH, 0 ;[-14] + ldi cnt, 2 ;[-13] +; rjmp usbSendAndReti fallthrough + +;usbSend: +;pointer to data in 'Y' +;number of bytes in 'cnt' -- including sync byte [range 2 ... 12] +;uses: x1...x4, btcnt, shift, cnt, Y +;Numbers in brackets are time since first bit of sync pattern is sent +;We don't match the transfer rate exactly (don't insert leap cycles every third +;byte) because the spec demands only 1.5% precision anyway. +usbSendAndReti: ; 12 cycles until SOP + in x2, USBDDR ;[-12] + ori x2, USBMASK ;[-11] + sbi USBOUT, USBMINUS;[-10] prepare idle state; D+ and D- must have been 0 (no pullups) + in x1, USBOUT ;[-8] port mirror for tx loop + out USBDDR, x2 ;[-7] <- acquire bus +; need not init x2 (bitstuff history) because sync starts with 0 + ldi x4, USBMASK ;[-6] exor mask + ldi shift, 0x80 ;[-5] sync byte is first byte sent +txByteLoop: + ldi bitcnt, 0x35 ;[-4] [6] binary 0011 0101 +txBitLoop: + sbrs shift, 0 ;[-3] [7] + eor x1, x4 ;[-2] [8] + out USBOUT, x1 ;[-1] [9] <-- out N + ror shift ;[0] [10] + ror x2 ;[1] +didStuffN: + cpi x2, 0xfc ;[2] + brcc bitstuffN ;[3] + lsr bitcnt ;[4] + brcc txBitLoop ;[5] + brne txBitLoop ;[6] + + sbrs shift, 0 ;[7] + eor x1, x4 ;[8] +didStuff6: + out USBOUT, x1 ;[-1] [9] <-- out 6 + ror shift ;[0] [10] + ror x2 ;[1] + cpi x2, 0xfc ;[2] + brcc bitstuff6 ;[3] + ror shift ;[4] +didStuff7: + ror x2 ;[5] + sbrs x2, 7 ;[6] + eor x1, x4 ;[7] + nop ;[8] + cpi x2, 0xfc ;[9] + out USBOUT, x1 ;[-1][10] <-- out 7 + brcc bitstuff7 ;[0] [11] + ld shift, y+ ;[1] + dec cnt ;[3] + brne txByteLoop ;[4] +;make SE0: + cbr x1, USBMASK ;[5] prepare SE0 [spec says EOP may be 21 to 25 cycles] + lds x2, usbNewDeviceAddr;[6] + lsl x2 ;[8] we compare with left shifted address + subi YL, 20 + 2 ;[9] Only assign address on data packets, not ACK/NAK in x3 + sbci YH, 0 ;[10] + out USBOUT, x1 ;[11] <-- out SE0 -- from now 2 bits = 22 cycles until bus idle +;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: +;set address only after data packet was sent, not after handshake + breq skipAddrAssign ;[0] + sts usbDeviceAddr, x2; if not skipped: SE0 is one cycle longer +skipAddrAssign: +;end of usbDeviceAddress transfer + ldi x2, 1< max 52 cycles interrupt disable +;max stack usage: [ret(2), r0, SREG, YL, YH, shift, x1, x2, x3, x4, cnt] = 12 bytes +;nominal frequency: 16.5 MHz -> 11 cycles per bit +; 16.3125 MHz < F_CPU < 16.6875 MHz (+/- 1.1%) +; Numbers in brackets are clocks counted from center of last sync bit +; when instruction starts + + +USB_INTR_VECTOR: +;order of registers pushed: YL, SREG [sofError], r0, YH, shift, x1, x2, x3, x4, cnt + push YL ;[-23] push only what is necessary to sync with edge ASAP + in YL, SREG ;[-21] + push YL ;[-20] +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +;---------------------------------------------------------------------------- +;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +;sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +waitForK: +;The following code results in a sampling window of < 1/4 bit which meets the spec. + sbis USBIN, USBMINUS ;[-15] + rjmp foundK ;[-14] + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError +foundK: ;[-12] +;{3, 5} after falling D- edge, average delay: 4 cycles [we want 5 for center sampling] +;we have 1 bit time for setup purposes, then sample again. Numbers in brackets +;are cycles from center of first sync (double K) bit after the instruction + push r0 ;[-12] +; [---] ;[-11] + push YH ;[-10] +; [---] ;[-9] + lds YL, usbInputBufOffset;[-8] +; [---] ;[-7] + clr YH ;[-6] + subi YL, lo8(-(usbRxBuf));[-5] [rx loop init] + sbci YH, hi8(-(usbRxBuf));[-4] [rx loop init] + mov r0, x2 ;[-3] [rx loop init] + sbis USBIN, USBMINUS ;[-2] we want two bits K (sample 2 cycles too early) + rjmp haveTwoBitsK ;[-1] + pop YH ;[0] undo the pushes from before + pop r0 ;[2] + rjmp waitForK ;[4] this was not the end of sync, retry +; The entire loop from waitForK until rjmp waitForK above must not exceed two +; bit times (= 22 cycles). + +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- +haveTwoBitsK: ;[1] + push shift ;[1] + push x1 ;[3] + push x2 ;[5] + push x3 ;[7] + ldi shift, 0xff ;[9] [rx loop init] + ori x3, 0xff ;[10] [rx loop init] == ser x3, clear zero flag + + in x1, USBIN ;[11] <-- sample bit 0 + bst x1, USBMINUS ;[12] + bld shift, 0 ;[13] + push x4 ;[14] == phase +; [---] ;[15] + push cnt ;[16] +; [---] ;[17] + ldi phase, 0 ;[18] [rx loop init] + ldi cnt, USB_BUFSIZE;[19] [rx loop init] + rjmp rxbit1 ;[20] +; [---] ;[21] + +;---------------------------------------------------------------------------- +; Receiver loop (numbers in brackets are cycles within byte after instr) +;---------------------------------------------------------------------------- +/* +byte oriented operations done during loop: +bit 0: store data +bit 1: SE0 check +bit 2: overflow check +bit 3: catch up +bit 4: rjmp to achieve conditional jump range +bit 5: PLL +bit 6: catch up +bit 7: jump, fixup bitstuff +; 87 [+ 2] cycles +------------------------------------------------------------------ +*/ +continueWithBit5: + in x2, USBIN ;[055] <-- bit 5 + eor r0, x2 ;[056] + or phase, r0 ;[057] + sbrc phase, USBMINUS ;[058] + lpm ;[059] optional nop3; modifies r0 + in phase, USBIN ;[060] <-- phase + eor x1, x2 ;[061] + bst x1, USBMINUS ;[062] + bld shift, 5 ;[063] + andi shift, 0x3f ;[064] + in x1, USBIN ;[065] <-- bit 6 + breq unstuff5 ;[066] *** unstuff escape + eor phase, x1 ;[067] + eor x2, x1 ;[068] + bst x2, USBMINUS ;[069] + bld shift, 6 ;[070] +didUnstuff6: ;[ ] + in r0, USBIN ;[071] <-- phase + cpi shift, 0x02 ;[072] + brlo unstuff6 ;[073] *** unstuff escape +didUnstuff5: ;[ ] + nop2 ;[074] +; [---] ;[075] + in x2, USBIN ;[076] <-- bit 7 + eor x1, x2 ;[077] + bst x1, USBMINUS ;[078] + bld shift, 7 ;[079] +didUnstuff7: ;[ ] + eor r0, x2 ;[080] + or phase, r0 ;[081] + in r0, USBIN ;[082] <-- phase + cpi shift, 0x04 ;[083] + brsh rxLoop ;[084] +; [---] ;[085] +unstuff7: ;[ ] + andi x3, ~0x80 ;[085] + ori shift, 0x80 ;[086] + in x2, USBIN ;[087] <-- sample stuffed bit 7 + nop ;[088] + rjmp didUnstuff7 ;[089] +; [---] ;[090] + ;[080] + +unstuff5: ;[067] + eor phase, x1 ;[068] + andi x3, ~0x20 ;[069] + ori shift, 0x20 ;[070] + in r0, USBIN ;[071] <-- phase + mov x2, x1 ;[072] + nop ;[073] + nop2 ;[074] +; [---] ;[075] + in x1, USBIN ;[076] <-- bit 6 + eor r0, x1 ;[077] + or phase, r0 ;[078] + eor x2, x1 ;[079] + bst x2, USBMINUS ;[080] + bld shift, 6 ;[081] no need to check bitstuffing, we just had one + in r0, USBIN ;[082] <-- phase + rjmp didUnstuff5 ;[083] +; [---] ;[084] + ;[074] + +unstuff6: ;[074] + andi x3, ~0x40 ;[075] + in x1, USBIN ;[076] <-- bit 6 again + ori shift, 0x40 ;[077] + nop2 ;[078] +; [---] ;[079] + rjmp didUnstuff6 ;[080] +; [---] ;[081] + ;[071] + +unstuff0: ;[013] + eor r0, x2 ;[014] + or phase, r0 ;[015] + andi x2, USBMASK ;[016] check for SE0 + in r0, USBIN ;[017] <-- phase + breq didUnstuff0 ;[018] direct jump to se0 would be too long + andi x3, ~0x01 ;[019] + ori shift, 0x01 ;[020] + mov x1, x2 ;[021] mov existing sample + in x2, USBIN ;[022] <-- bit 1 again + rjmp didUnstuff0 ;[023] +; [---] ;[024] + ;[014] + +unstuff1: ;[024] + eor r0, x1 ;[025] + or phase, r0 ;[026] + andi x3, ~0x02 ;[027] + in r0, USBIN ;[028] <-- phase + ori shift, 0x02 ;[029] + mov x2, x1 ;[030] + rjmp didUnstuff1 ;[031] +; [---] ;[032] + ;[022] + +unstuff2: ;[035] + eor r0, x2 ;[036] + or phase, r0 ;[037] + andi x3, ~0x04 ;[038] + in r0, USBIN ;[039] <-- phase + ori shift, 0x04 ;[040] + mov x1, x2 ;[041] + rjmp didUnstuff2 ;[042] +; [---] ;[043] + ;[033] + +unstuff3: ;[043] + in x2, USBIN ;[044] <-- bit 3 again + eor r0, x2 ;[045] + or phase, r0 ;[046] + andi x3, ~0x08 ;[047] + ori shift, 0x08 ;[048] + nop ;[049] + in r0, USBIN ;[050] <-- phase + rjmp didUnstuff3 ;[051] +; [---] ;[052] + ;[042] + +unstuff4: ;[053] + andi x3, ~0x10 ;[054] + in x1, USBIN ;[055] <-- bit 4 again + ori shift, 0x10 ;[056] + rjmp didUnstuff4 ;[057] +; [---] ;[058] + ;[048] + +rxLoop: ;[085] + eor x3, shift ;[086] reconstruct: x3 is 0 at bit locations we changed, 1 at others + in x1, USBIN ;[000] <-- bit 0 + st y+, x3 ;[001] +; [---] ;[002] + eor r0, x1 ;[003] + or phase, r0 ;[004] + eor x2, x1 ;[005] + in r0, USBIN ;[006] <-- phase + ser x3 ;[007] + bst x2, USBMINUS ;[008] + bld shift, 0 ;[009] + andi shift, 0xf9 ;[010] +rxbit1: ;[ ] + in x2, USBIN ;[011] <-- bit 1 + breq unstuff0 ;[012] *** unstuff escape + andi x2, USBMASK ;[013] SE0 check for bit 1 +didUnstuff0: ;[ ] Z only set if we detected SE0 in bitstuff + breq se0 ;[014] + eor r0, x2 ;[015] + or phase, r0 ;[016] + in r0, USBIN ;[017] <-- phase + eor x1, x2 ;[018] + bst x1, USBMINUS ;[019] + bld shift, 1 ;[020] + andi shift, 0xf3 ;[021] +didUnstuff1: ;[ ] + in x1, USBIN ;[022] <-- bit 2 + breq unstuff1 ;[023] *** unstuff escape + eor r0, x1 ;[024] + or phase, r0 ;[025] + subi cnt, 1 ;[026] overflow check + brcs overflow ;[027] + in r0, USBIN ;[028] <-- phase + eor x2, x1 ;[029] + bst x2, USBMINUS ;[030] + bld shift, 2 ;[031] + andi shift, 0xe7 ;[032] +didUnstuff2: ;[ ] + in x2, USBIN ;[033] <-- bit 3 + breq unstuff2 ;[034] *** unstuff escape + eor r0, x2 ;[035] + or phase, r0 ;[036] + eor x1, x2 ;[037] + bst x1, USBMINUS ;[038] + in r0, USBIN ;[039] <-- phase + bld shift, 3 ;[040] + andi shift, 0xcf ;[041] +didUnstuff3: ;[ ] + breq unstuff3 ;[042] *** unstuff escape + nop ;[043] + in x1, USBIN ;[044] <-- bit 4 + eor x2, x1 ;[045] + bst x2, USBMINUS ;[046] + bld shift, 4 ;[047] +didUnstuff4: ;[ ] + eor r0, x1 ;[048] + or phase, r0 ;[049] + in r0, USBIN ;[050] <-- phase + andi shift, 0x9f ;[051] + breq unstuff4 ;[052] *** unstuff escape + rjmp continueWithBit5;[053] +; [---] ;[054] + +macro POP_STANDARD ; 16 cycles + pop cnt + pop x4 + pop x3 + pop x2 + pop x1 + pop shift + pop YH + pop r0 + endm +macro POP_RETI ; 5 cycles + pop YL + out SREG, YL + pop YL + endm + +#include "asmcommon.inc" + + +; USB spec says: +; idle = J +; J = (D+ = 0), (D- = 1) +; K = (D+ = 1), (D- = 0) +; Spec allows 7.5 bit times from EOP to SOP for replies + +bitstuff7: + eor x1, x4 ;[4] + ldi x2, 0 ;[5] + nop2 ;[6] C is zero (brcc) + rjmp didStuff7 ;[8] + +bitstuffN: + eor x1, x4 ;[5] + ldi x2, 0 ;[6] + lpm ;[7] 3 cycle NOP, modifies r0 + out USBOUT, x1 ;[10] <-- out + rjmp didStuffN ;[0] + +#define bitStatus x3 + +sendNakAndReti: + ldi cnt, USBPID_NAK ;[-19] + rjmp sendCntAndReti ;[-18] +sendAckAndReti: + ldi cnt, USBPID_ACK ;[-17] +sendCntAndReti: + mov r0, cnt ;[-16] + ldi YL, 0 ;[-15] R0 address is 0 + ldi YH, 0 ;[-14] + ldi cnt, 2 ;[-13] +; rjmp usbSendAndReti fallthrough + +;usbSend: +;pointer to data in 'Y' +;number of bytes in 'cnt' -- including sync byte [range 2 ... 12] +;uses: x1...x4, shift, cnt, Y +;Numbers in brackets are time since first bit of sync pattern is sent +usbSendAndReti: ; 12 cycles until SOP + in x2, USBDDR ;[-12] + ori x2, USBMASK ;[-11] + sbi USBOUT, USBMINUS;[-10] prepare idle state; D+ and D- must have been 0 (no pullups) + in x1, USBOUT ;[-8] port mirror for tx loop + out USBDDR, x2 ;[-7] <- acquire bus +; need not init x2 (bitstuff history) because sync starts with 0 + ldi x4, USBMASK ;[-6] exor mask + ldi shift, 0x80 ;[-5] sync byte is first byte sent + ldi bitStatus, 0xff ;[-4] init bit loop counter, works for up to 12 bytes +byteloop: +bitloop: + sbrs shift, 0 ;[8] [-3] + eor x1, x4 ;[9] [-2] + out USBOUT, x1 ;[10] [-1] <-- out + ror shift ;[0] + ror x2 ;[1] +didStuffN: + cpi x2, 0xfc ;[2] + brcc bitstuffN ;[3] + nop ;[4] + subi bitStatus, 37 ;[5] 256 / 7 ~=~ 37 + brcc bitloop ;[6] when we leave the loop, bitStatus has almost the initial value + sbrs shift, 0 ;[7] + eor x1, x4 ;[8] + ror shift ;[9] +didStuff7: + out USBOUT, x1 ;[10] <-- out + ror x2 ;[0] + cpi x2, 0xfc ;[1] + brcc bitstuff7 ;[2] + ld shift, y+ ;[3] + dec cnt ;[5] + brne byteloop ;[6] +;make SE0: + cbr x1, USBMASK ;[7] prepare SE0 [spec says EOP may be 21 to 25 cycles] + lds x2, usbNewDeviceAddr;[8] + lsl x2 ;[10] we compare with left shifted address + out USBOUT, x1 ;[11] <-- out SE0 -- from now 2 bits = 22 cycles until bus idle +;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: +;set address only after data packet was sent, not after handshake + subi YL, 2 ;[0] Only assign address on data packets, not ACK/NAK in r0 + sbci YH, 0 ;[1] + breq skipAddrAssign ;[2] + sts usbDeviceAddr, x2; if not skipped: SE0 is one cycle longer +skipAddrAssign: +;end of usbDeviceAddress transfer + ldi x2, 1< 12 cycles per bit +; Numbers in brackets are clocks counted from center of last sync bit +; when instruction starts +;register use in receive loop to receive the data bytes: +; shift assembles the byte currently being received +; x1 holds the D+ and D- line state +; x2 holds the previous line state +; cnt holds the number of bytes left in the receive buffer +; x3 holds the higher crc byte (see algorithm below) +; x4 is used as temporary register for the crc algorithm +; x5 is used for unstuffing: when unstuffing the last received bit is inverted in shift (to prevent further +; unstuffing calls. In the same time the corresponding bit in x5 is cleared to mark the bit as beening iverted +; zl lower crc value and crc table index +; zh used for crc table accesses + +;-------------------------------------------------------------------------------------------------------------- +; CRC mods: +; table driven crc checker, Z points to table in prog space +; ZL is the lower crc byte, x3 is the higher crc byte +; x4 is used as temp register to store different results +; the initialization of the crc register is not 0xFFFF but 0xFE54. This is because during the receipt of the +; first data byte an virtual zero data byte is added to the crc register, this results in the correct initial +; value of 0xFFFF at beginning of the second data byte before the first data byte is added to the crc. +; The magic number 0xFE54 results form the crc table: At tabH[0x54] = 0xFF = crcH (required) and +; tabL[0x54] = 0x01 -> crcL = 0x01 xor 0xFE = 0xFF +; bitcnt is renamed to x5 and is used for unstuffing purposes, the unstuffing works like in the 12MHz version +;-------------------------------------------------------------------------------------------------------------- +; CRC algorithm: +; The crc register is formed by x3 (higher byte) and ZL (lower byte). The algorithm uses a 'reversed' form +; i.e. that it takes the least significant bit first and shifts to the right. So in fact the highest order +; bit seen from the polynomial devision point of view is the lsb of ZL. (If this sounds strange to you i +; propose a research on CRC :-) ) +; Each data byte received is xored to ZL, the lower crc byte. This byte now builds the crc +; table index. Next the new high byte is loaded from the table and stored in x4 until we have space in x3 +; (its destination). +; Afterwards the lower table is loaded from the table and stored in ZL (the old index is overwritten as +; we don't need it anymore. In fact this is a right shift by 8 bits.) Now the old crc high value is xored +; to ZL, this is the second shift of the old crc value. Now x4 (the temp reg) is moved to x3 and the crc +; calculation is done. +; Prior to the first byte the two CRC register have to be initialized to 0xFFFF (as defined in usb spec) +; however the crc engine also runs during the receipt of the first byte, therefore x3 and zl are initialized +; to a magic number which results in a crc value of 0xFFFF after the first complete byte. +; +; This algorithm is split into the extra cycles of the different bits: +; bit7: XOR the received byte to ZL +; bit5: load the new high byte to x4 +; bit6: load the lower xor byte from the table, xor zl and x3, store result in zl (=the new crc low value) +; move x4 (the new high byte) to x3, the crc value is ready +; + + +macro POP_STANDARD ; 18 cycles + pop ZH + pop ZL + pop cnt + pop x5 + pop x3 + pop x2 + pop x1 + pop shift + pop x4 + endm +macro POP_RETI ; 7 cycles + pop YH + pop YL + out SREG, YL + pop YL + endm + +macro CRC_CLEANUP_AND_CHECK + ; the last byte has already been xored with the lower crc byte, we have to do the table lookup and xor + ; x3 is the higher crc byte, zl the lower one + ldi ZH, hi8(usbCrcTableHigh);[+1] get the new high byte from the table + lpm x2, Z ;[+2][+3][+4] + ldi ZH, hi8(usbCrcTableLow);[+5] get the new low xor byte from the table + lpm ZL, Z ;[+6][+7][+8] + eor ZL, x3 ;[+7] xor the old high byte with the value from the table, x2:ZL now holds the crc value + cpi ZL, 0x01 ;[+8] if the crc is ok we have a fixed remainder value of 0xb001 in x2:ZL (see usb spec) + brne ignorePacket ;[+9] detected a crc fault -> paket is ignored and retransmitted by the host + cpi x2, 0xb0 ;[+10] + brne ignorePacket ;[+11] detected a crc fault -> paket is ignored and retransmitted by the host + endm + + +USB_INTR_VECTOR: +;order of registers pushed: YL, SREG, YH, [sofError], x4, shift, x1, x2, x3, x5, cnt, ZL, ZH + push YL ;[-28] push only what is necessary to sync with edge ASAP + in YL, SREG ;[-26] + push YL ;[-25] + push YH ;[-23] +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +;---------------------------------------------------------------------------- +;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +;sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +waitForK: +;The following code results in a sampling window of < 1/4 bit which meets the spec. + sbis USBIN, USBMINUS ;[-17] + rjmp foundK ;[-16] + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError +foundK: ;[-15] +;{3, 5} after falling D- edge, average delay: 4 cycles +;bit0 should be at 30 (2.5 bits) for center sampling. Currently at 4 so 26 cylces till bit 0 sample +;use 1 bit time for setup purposes, then sample again. Numbers in brackets +;are cycles from center of first sync (double K) bit after the instruction + push x4 ;[-14] +; [---] ;[-13] + lds YL, usbInputBufOffset;[-12] used to toggle the two usb receive buffers +; [---] ;[-11] + clr YH ;[-10] + subi YL, lo8(-(usbRxBuf));[-9] [rx loop init] + sbci YH, hi8(-(usbRxBuf));[-8] [rx loop init] + push shift ;[-7] +; [---] ;[-6] + ldi shift, 0x80 ;[-5] the last bit is the end of byte marker for the pid receiver loop + clc ;[-4] the carry has to be clear for receipt of pid bit 0 + sbis USBIN, USBMINUS ;[-3] we want two bits K (sample 3 cycles too early) + rjmp haveTwoBitsK ;[-2] + pop shift ;[-1] undo the push from before + pop x4 ;[1] + rjmp waitForK ;[3] this was not the end of sync, retry +; The entire loop from waitForK until rjmp waitForK above must not exceed two +; bit times (= 24 cycles). + +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- +haveTwoBitsK: + push x1 ;[0] + push x2 ;[2] + push x3 ;[4] crc high byte + ldi x2, 1< jump back and store the byte + ori shift, 0x01 ;[11] invert the last received bit to prevent furhter unstuffing + in x2, USBIN ;[0] we have some free cycles so we could check for bit stuffing errors + andi x5, 0xFE ;[1] mark this bit as inverted (will be corrected before storing shift) + eor x1, x2 ;[2] x1 and x2 have to be different because the stuff bit is always a zero + andi x1, USBMASK ;[3] mask the interesting bits + breq stuffErr ;[4] if the stuff bit is a 1-bit something went wrong + mov x1, x2 ;[5] the next bit expects the last state to be in x1 + rjmp didunstuff0 ;[6] + ;[7] jump delay of rjmp didunstuffX + +unstuff1: ;[11] this is the jump delay of breq unstuffX + in x1, USBIN ;[0] we have some free cycles so we could check for bit stuffing errors + ori shift, 0x02 ;[1] invert the last received bit to prevent furhter unstuffing + andi x5, 0xFD ;[2] mark this bit as inverted (will be corrected before storing shift) + eor x2, x1 ;[3] x1 and x2 have to be different because the stuff bit is always a zero + andi x2, USBMASK ;[4] mask the interesting bits + breq stuffErr ;[5] if the stuff bit is a 1-bit something went wrong + mov x2, x1 ;[6] the next bit expects the last state to be in x2 + nop2 ;[7] + ;[8] + rjmp didunstuff1 ;[9] + ;[10] jump delay of rjmp didunstuffX + +unstuff2: ;[9] this is the jump delay of breq unstuffX + ori shift, 0x04 ;[10] invert the last received bit to prevent furhter unstuffing + andi x5, 0xFB ;[11] mark this bit as inverted (will be corrected before storing shift) + in x2, USBIN ;[0] we have some free cycles so we could check for bit stuffing errors + eor x1, x2 ;[1] x1 and x2 have to be different because the stuff bit is always a zero + andi x1, USBMASK ;[2] mask the interesting bits + breq stuffErr ;[3] if the stuff bit is a 1-bit something went wrong + mov x1, x2 ;[4] the next bit expects the last state to be in x1 + nop2 ;[5] + ;[6] + rjmp didunstuff2 ;[7] + ;[8] jump delay of rjmp didunstuffX + +unstuff3: ;[9] this is the jump delay of breq unstuffX + ori shift, 0x08 ;[10] invert the last received bit to prevent furhter unstuffing + andi x5, 0xF7 ;[11] mark this bit as inverted (will be corrected before storing shift) + in x1, USBIN ;[0] we have some free cycles so we could check for bit stuffing errors + eor x2, x1 ;[1] x1 and x2 have to be different because the stuff bit is always a zero + andi x2, USBMASK ;[2] mask the interesting bits + breq stuffErr ;[3] if the stuff bit is a 1-bit something went wrong + mov x2, x1 ;[4] the next bit expects the last state to be in x2 + nop2 ;[5] + ;[6] + rjmp didunstuff3 ;[7] + ;[8] jump delay of rjmp didunstuffX + + + +; the include has to be here due to branch distance restirctions +#define __USE_CRC__ +#include "asmcommon.inc" + + + +; USB spec says: +; idle = J +; J = (D+ = 0), (D- = 1) +; K = (D+ = 1), (D- = 0) +; Spec allows 7.5 bit times from EOP to SOP for replies +; 7.5 bit times is 90 cycles. ...there is plenty of time + + +sendNakAndReti: + ldi x3, USBPID_NAK ;[-18] + rjmp sendX3AndReti ;[-17] +sendAckAndReti: + ldi cnt, USBPID_ACK ;[-17] +sendCntAndReti: + mov x3, cnt ;[-16] +sendX3AndReti: + ldi YL, 20 ;[-15] x3==r20 address is 20 + ldi YH, 0 ;[-14] + ldi cnt, 2 ;[-13] +; rjmp usbSendAndReti fallthrough + +;usbSend: +;pointer to data in 'Y' +;number of bytes in 'cnt' -- including sync byte [range 2 ... 12] +;uses: x1...x4, btcnt, shift, cnt, Y +;Numbers in brackets are time since first bit of sync pattern is sent + +usbSendAndReti: ; 12 cycles until SOP + in x2, USBDDR ;[-12] + ori x2, USBMASK ;[-11] + sbi USBOUT, USBMINUS;[-10] prepare idle state; D+ and D- must have been 0 (no pullups) + in x1, USBOUT ;[-8] port mirror for tx loop + out USBDDR, x2 ;[-6] <- acquire bus + ldi x2, 0 ;[-6] init x2 (bitstuff history) because sync starts with 0 + ldi x4, USBMASK ;[-5] exor mask + ldi shift, 0x80 ;[-4] sync byte is first byte sent +txByteLoop: + ldi bitcnt, 0x40 ;[-3]=[9] binary 01000000 +txBitLoop: ; the loop sends the first 7 bits of the byte + sbrs shift, 0 ;[-2]=[10] if we have to send a 1 don't change the line state + eor x1, x4 ;[-1]=[11] + out USBOUT, x1 ;[0] + ror shift ;[1] + ror x2 ;[2] transfers the last sent bit to the stuffing history +didStuffN: + nop ;[3] + nop ;[4] + cpi x2, 0xfc ;[5] if we sent six consecutive ones + brcc bitstuffN ;[6] + lsr bitcnt ;[7] + brne txBitLoop ;[8] restart the loop while the 1 is still in the bitcount + +; transmit bit 7 + sbrs shift, 0 ;[9] + eor x1, x4 ;[10] +didStuff7: + ror shift ;[11] + out USBOUT, x1 ;[0] transfer bit 7 to the pins + ror x2 ;[1] move the bit into the stuffing history + cpi x2, 0xfc ;[2] + brcc bitstuff7 ;[3] + ld shift, y+ ;[4] get next byte to transmit + dec cnt ;[5] decrement byte counter + brne txByteLoop ;[7] if we have more bytes start next one + ;[8] branch delay + +;make SE0: + cbr x1, USBMASK ;[8] prepare SE0 [spec says EOP may be 25 to 30 cycles] + lds x2, usbNewDeviceAddr;[9] + lsl x2 ;[11] we compare with left shifted address + out USBOUT, x1 ;[0] <-- out SE0 -- from now 2 bits = 24 cycles until bus idle + subi YL, 20 + 2 ;[1] Only assign address on data packets, not ACK/NAK in x3 + sbci YH, 0 ;[2] +;2006-03-06: moved transfer of new address to usbDeviceAddr from C-Code to asm: +;set address only after data packet was sent, not after handshake + breq skipAddrAssign ;[3] + sts usbDeviceAddr, x2 ; if not skipped: SE0 is one cycle longer +skipAddrAssign: +;end of usbDeviceAddress transfer + ldi x2, 1< +int main (int argc, char **argv) +{ + int i, j; + for (i=0; i<512; i++){ + unsigned short crc = i & 0xff; + for(j=0; j<8; j++) crc = (crc >> 1) ^ ((crc & 1) ? 0xa001 : 0); + if((i & 7) == 0) printf("\n.byte "); + printf("0x%02x, ", (i > 0xff ? (crc >> 8) : crc) & 0xff); + if(i == 255) printf("\n"); + } + return 0; +} + +// Use the following algorithm to compute CRC values: +ushort computeCrc(uchar *msg, uchar msgLen) +{ + uchar i; + ushort crc = 0xffff; + for(i = 0; i < msgLen; i++) + crc = usbCrcTable16[lo8(crc) ^ msg[i]] ^ hi8(crc); + return crc; +} +*/ + +.balign 256 +usbCrcTableLow: +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x00, 0xC1, 0x81, 0x40, 0x01, 0xC0, 0x80, 0x41 +.byte 0x01, 0xC0, 0x80, 0x41, 0x00, 0xC1, 0x81, 0x40 + +; .balign 256 +usbCrcTableHigh: +.byte 0x00, 0xC0, 0xC1, 0x01, 0xC3, 0x03, 0x02, 0xC2 +.byte 0xC6, 0x06, 0x07, 0xC7, 0x05, 0xC5, 0xC4, 0x04 +.byte 0xCC, 0x0C, 0x0D, 0xCD, 0x0F, 0xCF, 0xCE, 0x0E +.byte 0x0A, 0xCA, 0xCB, 0x0B, 0xC9, 0x09, 0x08, 0xC8 +.byte 0xD8, 0x18, 0x19, 0xD9, 0x1B, 0xDB, 0xDA, 0x1A +.byte 0x1E, 0xDE, 0xDF, 0x1F, 0xDD, 0x1D, 0x1C, 0xDC +.byte 0x14, 0xD4, 0xD5, 0x15, 0xD7, 0x17, 0x16, 0xD6 +.byte 0xD2, 0x12, 0x13, 0xD3, 0x11, 0xD1, 0xD0, 0x10 +.byte 0xF0, 0x30, 0x31, 0xF1, 0x33, 0xF3, 0xF2, 0x32 +.byte 0x36, 0xF6, 0xF7, 0x37, 0xF5, 0x35, 0x34, 0xF4 +.byte 0x3C, 0xFC, 0xFD, 0x3D, 0xFF, 0x3F, 0x3E, 0xFE +.byte 0xFA, 0x3A, 0x3B, 0xFB, 0x39, 0xF9, 0xF8, 0x38 +.byte 0x28, 0xE8, 0xE9, 0x29, 0xEB, 0x2B, 0x2A, 0xEA +.byte 0xEE, 0x2E, 0x2F, 0xEF, 0x2D, 0xED, 0xEC, 0x2C +.byte 0xE4, 0x24, 0x25, 0xE5, 0x27, 0xE7, 0xE6, 0x26 +.byte 0x22, 0xE2, 0xE3, 0x23, 0xE1, 0x21, 0x20, 0xE0 +.byte 0xA0, 0x60, 0x61, 0xA1, 0x63, 0xA3, 0xA2, 0x62 +.byte 0x66, 0xA6, 0xA7, 0x67, 0xA5, 0x65, 0x64, 0xA4 +.byte 0x6C, 0xAC, 0xAD, 0x6D, 0xAF, 0x6F, 0x6E, 0xAE +.byte 0xAA, 0x6A, 0x6B, 0xAB, 0x69, 0xA9, 0xA8, 0x68 +.byte 0x78, 0xB8, 0xB9, 0x79, 0xBB, 0x7B, 0x7A, 0xBA +.byte 0xBE, 0x7E, 0x7F, 0xBF, 0x7D, 0xBD, 0xBC, 0x7C +.byte 0xB4, 0x74, 0x75, 0xB5, 0x77, 0xB7, 0xB6, 0x76 +.byte 0x72, 0xB2, 0xB3, 0x73, 0xB1, 0x71, 0x70, 0xB0 +.byte 0x50, 0x90, 0x91, 0x51, 0x93, 0x53, 0x52, 0x92 +.byte 0x96, 0x56, 0x57, 0x97, 0x55, 0x95, 0x94, 0x54 +.byte 0x9C, 0x5C, 0x5D, 0x9D, 0x5F, 0x9F, 0x9E, 0x5E +.byte 0x5A, 0x9A, 0x9B, 0x5B, 0x99, 0x59, 0x58, 0x98 +.byte 0x88, 0x48, 0x49, 0x89, 0x4B, 0x8B, 0x8A, 0x4A +.byte 0x4E, 0x8E, 0x8F, 0x4F, 0x8D, 0x4D, 0x4C, 0x8C +.byte 0x44, 0x84, 0x85, 0x45, 0x87, 0x47, 0x46, 0x86 +.byte 0x82, 0x42, 0x43, 0x83, 0x41, 0x81, 0x80, 0x40 + diff --git a/classic/fw/usbdrv/usbdrvasm20.inc b/classic/fw/usbdrv/usbdrvasm20.inc new file mode 100644 index 0000000..5027edd --- /dev/null +++ b/classic/fw/usbdrv/usbdrvasm20.inc @@ -0,0 +1,359 @@ +/* Name: usbdrvasm20.inc + * Project: V-USB, virtual USB port for Atmel's(r) AVR(r) microcontrollers + * Author: Jeroen Benschop + * Based on usbdrvasm16.inc from Christian Starkjohann + * Creation Date: 2008-03-05 + * Tabsize: 4 + * Copyright: (c) 2008 by Jeroen Benschop and OBJECTIVE DEVELOPMENT Software GmbH + * License: GNU GPL v2 (see License.txt), GNU GPL v3 or proprietary (CommercialLicense.txt) + */ + +/* Do not link this file! Link usbdrvasm.S instead, which includes the + * appropriate implementation! + */ + +/* +General Description: +This file is the 20 MHz version of the asssembler part of the USB driver. It +requires a 20 MHz crystal (not a ceramic resonator and not a calibrated RC +oscillator). + +See usbdrv.h for a description of the entire driver. + +Since almost all of this code is timing critical, don't change unless you +really know what you are doing! Many parts require not only a maximum number +of CPU cycles, but even an exact number of cycles! +*/ + +#define leap2 x3 +#ifdef __IAR_SYSTEMS_ASM__ +#define nextInst $+2 +#else +#define nextInst .+0 +#endif + +;max stack usage: [ret(2), YL, SREG, YH, bitcnt, shift, x1, x2, x3, x4, cnt] = 12 bytes +;nominal frequency: 20 MHz -> 13.333333 cycles per bit, 106.666667 cycles per byte +; Numbers in brackets are clocks counted from center of last sync bit +; when instruction starts +;register use in receive loop: +; shift assembles the byte currently being received +; x1 holds the D+ and D- line state +; x2 holds the previous line state +; x4 (leap) is used to add a leap cycle once every three bytes received +; X3 (leap2) is used to add a leap cycle once every three stuff bits received +; bitcnt is used to determine when a stuff bit is due +; cnt holds the number of bytes left in the receive buffer + +USB_INTR_VECTOR: +;order of registers pushed: YL, SREG YH, [sofError], bitcnt, shift, x1, x2, x3, x4, cnt + push YL ;[-28] push only what is necessary to sync with edge ASAP + in YL, SREG ;[-26] + push YL ;[-25] + push YH ;[-23] +;---------------------------------------------------------------------------- +; Synchronize with sync pattern: +;---------------------------------------------------------------------------- +;sync byte (D-) pattern LSb to MSb: 01010100 [1 = idle = J, 0 = K] +;sync up with J to K edge during sync pattern -- use fastest possible loops +;The first part waits at most 1 bit long since we must be in sync pattern. +;YL is guarenteed to be < 0x80 because I flag is clear. When we jump to +;waitForJ, ensure that this prerequisite is met. +waitForJ: + inc YL + sbis USBIN, USBMINUS + brne waitForJ ; just make sure we have ANY timeout +waitForK: +;The following code results in a sampling window of < 1/4 bit which meets the spec. + sbis USBIN, USBMINUS ;[-19] + rjmp foundK ;[-18] + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK + sbis USBIN, USBMINUS + rjmp foundK +#if USB_COUNT_SOF + lds YL, usbSofCount + inc YL + sts usbSofCount, YL +#endif /* USB_COUNT_SOF */ +#ifdef USB_SOF_HOOK + USB_SOF_HOOK +#endif + rjmp sofError +foundK: ;[-16] +;{3, 5} after falling D- edge, average delay: 4 cycles +;bit0 should be at 34 for center sampling. Currently at 4 so 30 cylces till bit 0 sample +;use 1 bit time for setup purposes, then sample again. Numbers in brackets +;are cycles from center of first sync (double K) bit after the instruction + push bitcnt ;[-16] +; [---] ;[-15] + lds YL, usbInputBufOffset;[-14] +; [---] ;[-13] + clr YH ;[-12] + subi YL, lo8(-(usbRxBuf));[-11] [rx loop init] + sbci YH, hi8(-(usbRxBuf));[-10] [rx loop init] + push shift ;[-9] +; [---] ;[-8] + ldi shift,0x40 ;[-7] set msb to "1" so processing bit7 can be detected + nop2 ;[-6] +; [---] ;[-5] + ldi bitcnt, 5 ;[-4] [rx loop init] + sbis USBIN, USBMINUS ;[-3] we want two bits K (sample 3 cycles too early) + rjmp haveTwoBitsK ;[-2] + pop shift ;[-1] undo the push from before + pop bitcnt ;[1] + rjmp waitForK ;[3] this was not the end of sync, retry +; The entire loop from waitForK until rjmp waitForK above must not exceed two +; bit times (= 27 cycles). + +;---------------------------------------------------------------------------- +; push more registers and initialize values while we sample the first bits: +;---------------------------------------------------------------------------- +haveTwoBitsK: + push x1 ;[0] + push x2 ;[2] + push x3 ;[4] (leap2) + ldi leap2, 0x55 ;[6] add leap cycle on 2nd,5th,8th,... stuff bit + push x4 ;[7] == leap + ldi leap, 0x55 ;[9] skip leap cycle on 2nd,5th,8th,... byte received + push cnt ;[10] + ldi cnt, USB_BUFSIZE ;[12] [rx loop init] + ldi x2, 1< +#ifndef __IAR_SYSTEMS_ASM__ +# include +#endif + +#define __attribute__(arg) /* not supported on IAR */ + +#ifdef __IAR_SYSTEMS_ASM__ +# define __ASSEMBLER__ /* IAR does not define standard macro for asm */ +#endif + +#ifdef __HAS_ELPM__ +# define PROGMEM __farflash +#else +# define PROGMEM __flash +#endif + +#define USB_READ_FLASH(addr) (*(PROGMEM char *)(addr)) + +/* The following definitions are not needed by the driver, but may be of some + * help if you port a gcc based project to IAR. + */ +#define cli() __disable_interrupt() +#define sei() __enable_interrupt() +#define wdt_reset() __watchdog_reset() +#define _BV(x) (1 << (x)) + +/* assembler compatibility macros */ +#define nop2 rjmp $+2 /* jump to next instruction */ +#define XL r26 +#define XH r27 +#define YL r28 +#define YH r29 +#define ZL r30 +#define ZH r31 +#define lo8(x) LOW(x) +#define hi8(x) (((x)>>8) & 0xff) /* not HIGH to allow XLINK to make a proper range check */ + +/* Depending on the device you use, you may get problems with the way usbdrv.h + * handles the differences between devices. Since IAR does not use #defines + * for MCU registers, we can't check for the existence of a particular + * register with an #ifdef. If the autodetection mechanism fails, include + * definitions for the required USB_INTR_* macros in your usbconfig.h. See + * usbconfig-prototype.h and usbdrv.h for details. + */ + +/* ------------------------------------------------------------------------- */ +#elif __CODEVISIONAVR__ /* check for CodeVision AVR */ +/* ------------------------------------------------------------------------- */ +/* This port is not working (yet) */ + +/* #define F_CPU _MCU_CLOCK_FREQUENCY_ seems to be defined automatically */ + +#include +#include + +#define __attribute__(arg) /* not supported on IAR */ + +#define PROGMEM __flash +#define USB_READ_FLASH(addr) (*(PROGMEM char *)(addr)) + +#ifndef __ASSEMBLER__ +static inline void cli(void) +{ + #asm("cli"); +} +static inline void sei(void) +{ + #asm("sei"); +} +#endif +#define _delay_ms(t) delay_ms(t) +#define _BV(x) (1 << (x)) +#define USB_CFG_USE_SWITCH_STATEMENT 1 /* macro for if() cascase fails for unknown reason */ + +#define macro .macro +#define endm .endmacro +#define nop2 rjmp .+0 /* jump to next instruction */ + +/* ------------------------------------------------------------------------- */ +#else /* default development environment is avr-gcc/avr-libc */ +/* ------------------------------------------------------------------------- */ + +#include +#ifdef __ASSEMBLER__ +# define _VECTOR(N) __vector_ ## N /* io.h does not define this for asm */ +#else +# include +#endif + +#if USB_CFG_DRIVER_FLASH_PAGE +# define USB_READ_FLASH(addr) pgm_read_byte_far(((long)USB_CFG_DRIVER_FLASH_PAGE << 16) | (long)(addr)) +#else +# define USB_READ_FLASH(addr) pgm_read_byte(addr) +#endif + +#define macro .macro +#define endm .endm +#define nop2 rjmp .+0 /* jump to next instruction */ + +#endif /* development environment */ + +/* for conveniecne, ensure that PRG_RDB exists */ +#ifndef PRG_RDB +# define PRG_RDB(addr) USB_READ_FLASH(addr) +#endif +#endif /* __usbportability_h_INCLUDED__ */ diff --git a/classic/hw/classic-v1-rescue.lib b/classic/hw/classic-v1-rescue.lib new file mode 100644 index 0000000..338831f --- /dev/null +++ b/classic/hw/classic-v1-rescue.lib @@ -0,0 +1,191 @@ +EESchema-LIBRARY Version 2.4 +#encoding utf-8 +# +# ATTINY85 +# +DEF ATTINY85 U 0 40 Y Y 1 F N +F0 "U" -50 0 60 H V C CNN +F1 "ATTINY85" 0 750 60 H V C CNN +F2 "" 0 0 60 H V C CNN +F3 "" 0 0 60 H V C CNN +DRAW +S 400 -600 -450 650 0 1 0 N +X PB5/NRES 1 700 -450 300 L 50 50 1 1 B +X PB3/ADC1 2 700 -150 300 L 50 50 1 1 B +X PB4/ADC2 3 700 -300 300 L 50 50 1 1 B +X GND 4 -750 -450 300 R 50 50 1 1 w +X PB0/MOSI 5 700 500 300 L 50 50 1 1 B +X PB1/MISO 6 700 350 300 L 50 50 1 1 B +X PB2/SCK/ADC1 7 700 200 300 L 50 50 1 1 B +X VCC 8 -750 -150 300 R 50 50 1 1 W +X PB5/NRES 1 700 -450 300 L 50 50 1 2 B +X PB3/ADC1 2 700 -150 300 L 50 50 1 2 B +X PB4/ADC2 3 700 -300 300 L 50 50 1 2 B +X GND 4 -750 -450 300 R 50 50 1 2 w +X PB0/MOSI 5 700 500 300 L 50 50 1 2 B +X PB1/MISO 6 700 350 300 L 50 50 1 2 B +X PB2/SCK/ADC1 7 700 200 300 L 50 50 1 2 B +X VCC 8 -750 -150 300 R 50 50 1 2 W +ENDDRAW +ENDDEF +# +# C +# +DEF C C 0 10 N Y 1 F N +F0 "C" 0 100 40 H V L CNN +F1 "C" 6 -85 40 H V L CNN +F2 "" 38 -150 30 H V C CNN +F3 "" 0 0 60 H V C CNN +$FPLIST + SM* + C? + C1-1 +$ENDFPLIST +DRAW +P 2 0 1 20 -80 -30 80 -30 N +P 2 0 1 20 -80 30 80 30 N +X ~ 1 0 200 170 D 40 40 1 1 P +X ~ 2 0 -200 170 U 40 40 1 1 P +ENDDRAW +ENDDEF +# +# CP1 +# +DEF CP1 C 0 10 N N 1 F N +F0 "C" 50 100 50 H V L CNN +F1 "CP1" 50 -100 50 H V L CNN +F2 "" 0 0 60 H V C CNN +F3 "" 0 0 60 H V C CNN +$FPLIST + CP* + SM* +$ENDFPLIST +DRAW +A 0 -200 180 563 1236 0 1 15 N 100 -50 -100 -50 +T 0 -50 100 80 0 0 0 + Normal 0 C C +P 4 0 1 15 -100 50 100 50 50 50 50 50 N +X ~ 1 0 200 150 D 40 40 1 1 P +X ~ 2 0 -200 180 U 40 40 1 1 P +ENDDRAW +ENDDEF +# +# ESWITCH +# +DEF ESWITCH SW 0 40 Y Y 1 F N +F0 "SW" -100 250 60 H V C CNN +F1 "ESWITCH" 0 -250 60 H V C CNN +F2 "" -750 700 60 H V C CNN +F3 "" -750 700 60 H V C CNN +DRAW +S -200 -200 200 200 0 1 0 N +P 2 0 1 0 -200 -100 200 -100 N +P 2 0 1 0 0 -50 0 -100 N +P 2 0 1 0 0 -50 50 50 N +P 2 0 1 0 0 50 0 100 N +P 2 0 1 0 200 100 -200 100 N +X ~ 1 -500 100 300 R 50 50 1 1 P +X ~ 1 500 100 300 L 50 50 1 1 P +X ~ 2 -500 -100 300 R 50 50 1 1 P +X ~ 2 500 -100 300 L 50 50 1 1 P +ENDDRAW +ENDDEF +# +# ISP +# +DEF ISP J 0 40 Y Y 1 F N +F0 "J" -250 600 60 H V C CNN +F1 "ISP" -200 -550 60 H V C CNN +F2 "" 0 0 60 H V C CNN +F3 "" 0 0 60 H V C CNN +DRAW +S 0 550 -300 -500 0 1 0 N +X MISO 1 300 400 300 L 50 50 1 1 W +X +VCC 2 300 250 300 L 50 50 1 1 w +X SCK 3 300 100 300 L 50 50 1 1 B +X MOSI 4 300 -50 300 L 50 50 1 1 B +X RESET 5 300 -200 300 L 50 50 1 1 B +X GND 6 300 -350 300 L 50 50 1 1 B +ENDDRAW +ENDDEF +# +# LDO +# +DEF LDO U 0 40 Y Y 1 F N +F0 "U" -200 350 60 H V C CNN +F1 "LDO" 0 -350 60 H V C CNN +F2 "" -800 650 60 H V C CNN +F3 "" -800 650 60 H V C CNN +DRAW +S -250 -250 250 250 0 1 0 N +X IN 1 -550 150 300 R 50 50 1 1 W +X GND 2 -550 0 300 R 50 50 1 1 w +X EN 3 -550 -150 300 R 50 50 1 1 I +X BP 4 550 -150 300 L 50 50 1 1 P +X OUT 5 550 150 300 L 50 50 1 1 w +ENDDRAW +ENDDEF +# +# LED +# +DEF LED D 0 40 Y N 1 F N +F0 "D" 0 100 50 H V C CNN +F1 "LED" 0 -100 50 H V C CNN +F2 "" 0 0 60 H V C CNN +F3 "" 0 0 60 H V C CNN +$FPLIST + LED-3MM + LED-5MM + LED-10MM + LED-0603 + LED-0805 + LED-1206 + LEDV +$ENDFPLIST +DRAW +P 2 0 1 0 50 50 50 -50 N +P 3 0 1 0 -50 50 50 0 -50 -50 F +P 3 0 1 0 65 -40 110 -80 105 -55 N +P 3 0 1 0 80 -25 125 -65 120 -40 N +X A 1 -200 0 150 R 40 40 1 1 P +X K 2 200 0 150 L 40 40 1 1 P +ENDDRAW +ENDDEF +# +# R +# +DEF R R 0 0 N Y 1 F N +F0 "R" 80 0 40 V V C CNN +F1 "R" 7 1 40 V V C CNN +F2 "" -70 0 30 V V C CNN +F3 "" 0 0 30 H V C CNN +$FPLIST + R? + SM0603 + SM0805 + R?-* + SM1206 +$ENDFPLIST +DRAW +S -40 150 40 -150 0 1 12 N +X ~ 1 0 250 100 D 60 60 1 1 P +X ~ 2 0 -250 100 U 60 60 1 1 P +ENDDRAW +ENDDEF +# +# USB +# +DEF USB J 0 40 Y Y 1 F N +F0 "J" 0 -350 60 H V C CNN +F1 "USB" 0 -250 60 H V C CNN +F2 "" 0 0 60 H V C CNN +F3 "" 0 0 60 H V C CNN +DRAW +P 4 0 1 0 200 -400 200 50 -200 50 -200 -400 N +X GND 1 -150 350 300 D 50 50 1 1 w +X D+ 2 50 350 300 D 50 50 1 1 B +X D- 3 150 350 300 D 50 50 1 1 B +X VBUS 4 -50 350 300 D 50 50 1 1 W +ENDDRAW +ENDDEF +# +#End Library diff --git a/classic/hw/classic-v1.cmp b/classic/hw/classic-v1.cmp new file mode 100644 index 0000000..96bccff --- /dev/null +++ b/classic/hw/classic-v1.cmp @@ -0,0 +1,101 @@ +Cmp-Mod V01 Created by CvPcb (2013-07-07 BZR 4022)-stable date = 8/24/2014 12:22:47 PM + +BeginCmp +TimeStamp = /53F78D86; +Reference = C1; +ValeurCmp = 10uF; +IdModule = SM1206POL; +EndCmp + +BeginCmp +TimeStamp = /53F78E1D; +Reference = C2; +ValeurCmp = .1uF; +IdModule = SM1206; +EndCmp + +BeginCmp +TimeStamp = /53F78DE2; +Reference = C3; +ValeurCmp = .01uF; +IdModule = SM1206; +EndCmp + +BeginCmp +TimeStamp = /53F78E77; +Reference = C4; +ValeurCmp = 1uF; +IdModule = SM1206POL; +EndCmp + +BeginCmp +TimeStamp = /53F78DB1; +Reference = D1; +ValeurCmp = LED; +IdModule = LED-1206; +EndCmp + +BeginCmp +TimeStamp = /53F78CDD; +Reference = J1; +ValeurCmp = ISP; +IdModule = TRUDEAU_ISP_SMD_CLASSIC; +EndCmp + +BeginCmp +TimeStamp = /53F78CBD; +Reference = J2; +ValeurCmp = USB; +IdModule = TRUDEAU-USB-A-SMT-MALE; +EndCmp + +BeginCmp +TimeStamp = /53F78DA1; +Reference = R1; +ValeurCmp = 47; +IdModule = SM0805; +EndCmp + +BeginCmp +TimeStamp = /53F78FA7; +Reference = R2; +ValeurCmp = 1K5; +IdModule = SM0805; +EndCmp + +BeginCmp +TimeStamp = /53F78FA1; +Reference = R3; +ValeurCmp = 68; +IdModule = SM0805; +EndCmp + +BeginCmp +TimeStamp = /53F78F69; +Reference = R4; +ValeurCmp = 68; +IdModule = SM0805; +EndCmp + +BeginCmp +TimeStamp = /53F78CF3; +Reference = SW1; +ValeurCmp = ESWITCH; +IdModule = TRUDEAU-E-SWITCH; +EndCmp + +BeginCmp +TimeStamp = /53F78C6C; +Reference = U1; +ValeurCmp = ATTINY85; +IdModule = TRUDEAU-SOIC8-WIDE; +EndCmp + +BeginCmp +TimeStamp = /53F78C7B; +Reference = U2; +ValeurCmp = LDO; +IdModule = TRUDEAU-SOT23-5; +EndCmp + +EndListe diff --git a/classic/hw/classic-v1.kicad_pcb b/classic/hw/classic-v1.kicad_pcb new file mode 100644 index 0000000..905eb73 --- /dev/null +++ b/classic/hw/classic-v1.kicad_pcb @@ -0,0 +1,822 @@ +(kicad_pcb (version 20171130) (host pcbnew "(5.1.6)-1") + + (general + (thickness 1.6) + (drawings 4) + (tracks 160) + (zones 0) + (modules 14) + (nets 14) + ) + + (page A3) + (layers + (0 F.Cu signal) + (31 B.Cu signal) + (32 B.Adhes user) + (33 F.Adhes user) + (34 B.Paste user) + (35 F.Paste user) + (36 B.SilkS user) + (37 F.SilkS user) + (38 B.Mask user) + (39 F.Mask user) + (40 Dwgs.User user) + (41 Cmts.User user) + (42 Eco1.User user) + (43 Eco2.User user) + (44 Edge.Cuts user) + ) + + (setup + (last_trace_width 0.254) + (user_trace_width 0.127) + (trace_clearance 0.127) + (zone_clearance 0.254) + (zone_45_only no) + (trace_min 0.127) + (via_size 0.889) + (via_drill 0.635) + (via_min_size 0.555) + (via_min_drill 0.3352) + (user_via 0.555 0.3352) + (uvia_size 0.508) + (uvia_drill 0.127) + (uvias_allowed no) + (uvia_min_size 0.254) + (uvia_min_drill 0.063) + (edge_width 0.1) + (segment_width 0.2) + (pcb_text_width 0.3) + (pcb_text_size 1.5 1.5) + (mod_edge_width 0.15) + (mod_text_size 1 1) + (mod_text_width 0.15) + (pad_size 1.75 2.8) + (pad_drill 0) + (pad_to_mask_clearance 0) + (aux_axis_origin 0 0) + (visible_elements 7FFFFFFF) + (pcbplotparams + (layerselection 0x00030_ffffffff) + (usegerberextensions true) + (usegerberattributes true) + (usegerberadvancedattributes true) + (creategerberjobfile true) + (excludeedgelayer true) + (linewidth 0.150000) + (plotframeref false) + (viasonmask false) + (mode 1) + (useauxorigin false) + (hpglpennumber 1) + (hpglpenspeed 20) + (hpglpendiameter 15.000000) + (psnegative false) + (psa4output false) + (plotreference true) + (plotvalue true) + (plotinvisibletext false) + (padsonsilk false) + (subtractmaskfromsilk false) + (outputformat 1) + (mirror false) + (drillshape 0) + (scaleselection 1) + (outputdirectory "gerbers/")) + ) + + (net 0 "") + (net 1 GND) + (net 2 N-0000013) + (net 3 N-000006) + (net 4 N-000007) + (net 5 N-000009) + (net 6 PB0) + (net 7 PB1) + (net 8 PB2) + (net 9 PB3) + (net 10 PB4) + (net 11 PB5) + (net 12 VBUS) + (net 13 VCC) + + (net_class Default "This is the default net class." + (clearance 0.127) + (trace_width 0.254) + (via_dia 0.889) + (via_drill 0.635) + (uvia_dia 0.508) + (uvia_drill 0.127) + (add_net GND) + (add_net N-0000013) + (add_net N-000006) + (add_net N-000007) + (add_net N-000009) + (add_net PB0) + (add_net PB1) + (add_net PB2) + (add_net PB3) + (add_net PB4) + (add_net PB5) + (add_net VBUS) + (add_net VCC) + ) + + (module MICROJELLY-USB-A-SMT-MALE (layer F.Cu) (tedit 53FA1903) (tstamp 53F79302) + (at 229.451 150.419 270) + (path /53F78CBD) + (attr smd) + (fp_text reference J2 (at -4.369 25.5525 270) (layer B.SilkS) hide + (effects (font (size 1.27 1.27) (thickness 0.0889))) + ) + (fp_text value USB (at 1.7143 25.5906 270) (layer B.SilkS) hide + (effects (font (size 1.27 1.27) (thickness 0.0889))) + ) + (fp_line (start -3.99796 2.26822) (end 3.99796 2.26822) (layer F.SilkS) (width 0.2032)) + (pad 2 smd rect (at 1.02616 3.66776 270) (size 1.19888 1.99898) (layers F.Cu F.Paste F.Mask) + (net 4 N-000007)) + (pad 3 smd rect (at -1.02616 3.66776 270) (size 1.19888 1.99898) (layers F.Cu F.Paste F.Mask) + (net 3 N-000006)) + (pad 1 smd rect (at 3.49758 3.66776 270) (size 1.19888 1.99898) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (pad P$1 thru_hole oval (at 5.84962 1.09982 270) (size 1.4986 2.99974) (drill 0.79756) (layers *.Cu *.Mask F.Paste F.SilkS)) + (pad P$3 thru_hole oval (at -5.84962 1.09982 270) (size 1.4986 2.99974) (drill 0.79756) (layers *.Cu *.Mask F.Paste F.SilkS)) + (pad 4 smd rect (at -3.49758 3.66776 270) (size 1.19888 1.99898) (layers F.Cu F.Paste F.Mask) + (net 12 VBUS)) + (pad P$4 thru_hole circle (at 2.24028 1.14808 270) (size 1.099998 1.099998) (drill 1.099998) (layers *.Cu *.Mask F.SilkS)) + (pad P$5 thru_hole circle (at -2.24282 1.1684 270) (size 1.099998 1.099998) (drill 1.099998) (layers *.Cu *.Mask F.SilkS)) + (pad P$4 thru_hole circle (at -5.84962 0.40132 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$5 thru_hole circle (at -5.84962 0.78232 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$6 thru_hole circle (at -5.84962 1.84404 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$7 thru_hole circle (at -5.84962 1.49352 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$2 thru_hole circle (at 5.84962 0.34544 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$3 thru_hole circle (at 5.84962 0.73152 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$4 thru_hole circle (at 5.84962 1.86944 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + (pad P$5 thru_hole circle (at 5.84962 1.46812 270) (size 0.79756 0.79756) (drill 0.79756) (layers *.Cu F.Paste F.SilkS F.Mask)) + ) + + (module MICROJELLY_ISP_SMD_CLASSIC (layer B.Cu) (tedit 53FA18ED) (tstamp 53FA1098) + (at 213.944 150.444 270) + (path /53F78CDD) + (fp_text reference J1 (at 4.0261 9.9312 270) (layer B.SilkS) hide + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text value ISP (at -1.4857 9.8677 270) (layer B.SilkS) hide + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text user VCC (at 6.2105 -5.4358) (layer B.SilkS) + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text user GND (at 3.81 -5.334) (layer B.SilkS) + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text user PB0 (at 1.321 -5.258) (layer B.SilkS) + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text user PB1 (at -1.2952 -5.1437) (layer B.SilkS) + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text user PB2 (at -3.81 -5.334) (layer B.SilkS) + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (fp_text user PB5 (at -6.35 -5.334) (layer B.SilkS) + (effects (font (size 1 1) (thickness 0.15)) (justify mirror)) + ) + (pad 5 smd rect (at -6.35 -1.778 270) (size 1.75 2.8) (layers B.Cu B.Paste B.Mask) + (net 11 PB5)) + (pad 3 smd rect (at -3.81 -1.778 270) (size 1.75 2.8) (layers B.Cu B.Paste B.Mask) + (net 8 PB2)) + (pad 1 smd rect (at -1.27 -1.778 270) (size 1.75 2.8) (layers B.Cu B.Paste B.Mask) + (net 7 PB1)) + (pad 4 smd rect (at 1.27 -1.778 270) (size 1.75 2.8) (layers B.Cu B.Paste B.Mask) + (net 6 PB0)) + (pad 6 smd rect (at 3.81 -1.778 270) (size 1.75 2.8) (layers B.Cu B.Paste B.Mask) + (net 1 GND)) + (pad 2 smd rect (at 6.35 -1.778 270) (size 1.75 2.8) (layers B.Cu B.Paste B.Mask) + (net 13 VCC)) + ) + + (module MICROJELLY-SOT23-5 (layer F.Cu) (tedit 53FA14B2) (tstamp 53F7930F) + (at 220.815 148.895 90) + (path /53F78C7B) + (attr smd) + (fp_text reference U2 (at -0.0633 -0.0128 180) (layer F.SilkS) + (effects (font (size 0.635 0.635) (thickness 0.127))) + ) + (fp_text value LDO (at -2.9716 -16.7768 90) (layer F.SilkS) hide + (effects (font (size 0.635 0.635) (thickness 0.127))) + ) + (fp_line (start -1.524 -0.889) (end 1.524 -0.889) (layer F.SilkS) (width 0.127)) + (fp_line (start -1.524 0.889) (end -1.524 -0.889) (layer F.SilkS) (width 0.127)) + (fp_line (start 1.524 0.889) (end -1.524 0.889) (layer F.SilkS) (width 0.127)) + (fp_line (start 1.524 -0.889) (end 1.524 0.889) (layer F.SilkS) (width 0.127)) + (pad 1 smd rect (at -0.9525 1.27 90) (size 0.508 0.762) (layers F.Cu F.Paste F.Mask) + (net 12 VBUS)) + (pad 3 smd rect (at 0.9525 1.27 90) (size 0.508 0.762) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (pad 5 smd rect (at -0.9525 -1.27 90) (size 0.508 0.762) (layers F.Cu F.Paste F.Mask) + (net 13 VCC)) + (pad 2 smd rect (at 0 1.27 90) (size 0.508 0.762) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (pad 4 smd rect (at 0.9525 -1.27 90) (size 0.508 0.762) (layers F.Cu F.Paste F.Mask) + (net 2 N-0000013)) + (model smd/SOT23_5.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.1 0.1 0.1)) + (rotate (xyz 0 0 0)) + ) + ) + + (module MICROJELLY-SOIC8-WIDE (layer F.Cu) (tedit 53FA144B) (tstamp 53F79321) + (at 214.859 148.704 180) + (descr "module CMS SOJ 8 pins etroit") + (tags "CMS SOJ") + (path /53F78C6C) + (attr smd) + (fp_text reference U1 (at -1.4347 -1.0163 180) (layer F.SilkS) + (effects (font (size 1.143 1.143) (thickness 0.1524))) + ) + (fp_text value ATTINY85 (at 10.643 -4.6231 270) (layer F.SilkS) hide + (effects (font (size 0.889 0.889) (thickness 0.1524))) + ) + (fp_line (start 2.667 -1.905) (end 2.667 1.905) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.667 -1.905) (end -2.667 1.778) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.667 -1.905) (end -2.667 -1.905) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.667 1.905) (end 2.667 1.905) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.667 1.778) (end -2.667 1.905) (layer F.SilkS) (width 0.127)) + (fp_circle (center -2.11328 1.3335) (end -2.3876 1.24714) (layer F.SilkS) (width 0.15)) + (pad 8 smd rect (at -1.905 -3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 13 VCC)) + (pad 1 smd rect (at -1.905 3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 11 PB5)) + (pad 7 smd rect (at -0.635 -3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 8 PB2)) + (pad 6 smd rect (at 0.635 -3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 7 PB1)) + (pad 5 smd rect (at 1.905 -3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 6 PB0)) + (pad 2 smd rect (at -0.635 3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 9 PB3)) + (pad 3 smd rect (at 0.635 3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 10 PB4)) + (pad 4 smd rect (at 1.905 3.40106 180) (size 0.59944 2.32) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (model smd/cms_so8.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.5 0.32 0.5)) + (rotate (xyz 0 0 0)) + ) + ) + + (module MICROJELLY-E-SWITCH (layer F.Cu) (tedit 525C1661) (tstamp 53F79332) + (at 207.162 147.625 270) + (path /53F78CF3) + (attr smd) + (fp_text reference SW1 (at 0 0 270) (layer F.SilkS) + (effects (font (size 0.0004 0.0004) (thickness 0.00012))) + ) + (fp_text value ESWITCH (at 0 0 270) (layer F.SilkS) + (effects (font (size 0.0004 0.0004) (thickness 0.00012))) + ) + (fp_line (start 1.27 0.635) (end 1.27 -1.27) (layer F.SilkS) (width 0.127)) + (fp_line (start -1.27 0.635) (end 1.27 0.635) (layer F.SilkS) (width 0.127)) + (fp_line (start -1.27 -1.27) (end -1.27 0.635) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.3495 -1.7526) (end -2.3495 -1.7526) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.3495 1.7526) (end 2.3495 -1.7526) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.3495 1.7526) (end 2.3495 1.7526) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.3495 -1.7526) (end -2.3495 1.7526) (layer F.SilkS) (width 0.127)) + (pad 1 smd rect (at -2.6289 0.8763 270) (size 1.5494 0.9906) (layers F.Cu F.Paste F.Mask) + (net 8 PB2)) + (pad 1 smd rect (at 2.6289 0.8763 270) (size 1.5494 0.9906) (layers F.Cu F.Paste F.Mask) + (net 8 PB2)) + (pad 2 smd rect (at -2.6289 -0.8763 270) (size 1.5494 0.9906) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (pad 2 smd rect (at 2.6289 -0.8763 270) (size 1.5494 0.9906) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (pad P$5 thru_hole circle (at -0.01778 -1.39192 270) (size 0.762 0.762) (drill 0.762) (layers *.Cu *.Mask F.SilkS)) + (pad P$6 thru_hole circle (at -0.01524 1.36144 270) (size 0.762 0.762) (drill 0.762) (layers *.Cu *.Mask F.SilkS)) + ) + + (module SM1206POL (layer F.Cu) (tedit 53FA1462) (tstamp 53F79341) + (at 210.579 147.574 90) + (path /53F78D86) + (attr smd) + (fp_text reference C1 (at -0.0889 -0.2797 180) (layer F.SilkS) + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_text value 10uF (at -1.143 -6.4519 90) (layer F.SilkS) hide + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_line (start -0.889 -1.143) (end -2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 1.143) (end 0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 -1.143) (end 2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 0.889 -1.143) (end 2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 1.143) (end -0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 -1.143) (end -2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.794 1.143) (end -2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.794 -1.143) (end -2.794 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 -1.143) (end -2.794 -1.143) (layer F.SilkS) (width 0.127)) + (pad 1 smd rect (at -1.651 0 90) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 13 VCC)) + (pad 2 smd rect (at 1.651 0 90) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (model smd/chip_cms_pol.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.17 0.16 0.16)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM1206POL (layer F.Cu) (tedit 53FA14A0) (tstamp 53F79350) + (at 220.853 154.927 180) + (path /53F78E77) + (attr smd) + (fp_text reference C4 (at 0 0 180) (layer F.SilkS) + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_text value 1uF (at 16.7767 4.9781 270) (layer F.SilkS) hide + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_line (start -0.889 -1.143) (end -2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 1.143) (end 0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 -1.143) (end 2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 0.889 -1.143) (end 2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 1.143) (end -0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 -1.143) (end -2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.794 1.143) (end -2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.794 -1.143) (end -2.794 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 -1.143) (end -2.794 -1.143) (layer F.SilkS) (width 0.127)) + (pad 1 smd rect (at -1.651 0 180) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 13 VCC)) + (pad 2 smd rect (at 1.651 0 180) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (model smd/chip_cms_pol.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.17 0.16 0.16)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM1206 (layer F.Cu) (tedit 53FA14A5) (tstamp 53F7935C) + (at 220.904 152.082) + (path /53F78DE2) + (attr smd) + (fp_text reference C3 (at 0 0) (layer F.SilkS) + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_text value .01uF (at -16.8912 -3.2126 90) (layer F.SilkS) hide + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_line (start -0.889 -1.143) (end -2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 1.143) (end 0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 -1.143) (end 2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 0.889 -1.143) (end 2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 1.143) (end -0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 -1.143) (end -2.54 1.143) (layer F.SilkS) (width 0.127)) + (pad 1 smd rect (at -1.651 0) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 2 N-0000013)) + (pad 2 smd rect (at 1.651 0) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (model smd/chip_cms.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.17 0.16 0.16)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM1206 (layer F.Cu) (tedit 53FA14B6) (tstamp 53F79368) + (at 220.955 145.606) + (path /53F78E1D) + (attr smd) + (fp_text reference C2 (at 0 0) (layer F.SilkS) + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_text value .1uF (at -16.7898 7.3655 90) (layer F.SilkS) hide + (effects (font (size 0.762 0.762) (thickness 0.127))) + ) + (fp_line (start -0.889 -1.143) (end -2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 1.143) (end 0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 2.54 -1.143) (end 2.54 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start 0.889 -1.143) (end 2.54 -1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 1.143) (end -0.889 1.143) (layer F.SilkS) (width 0.127)) + (fp_line (start -2.54 -1.143) (end -2.54 1.143) (layer F.SilkS) (width 0.127)) + (pad 1 smd rect (at -1.651 0) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 12 VBUS)) + (pad 2 smd rect (at 1.651 0) (size 1.524 2.032) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + (model smd/chip_cms.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.17 0.16 0.16)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM0805 (layer F.Cu) (tedit 53FA1471) (tstamp 53F79375) + (at 210.185 155.321 270) + (path /53F78DA1) + (attr smd) + (fp_text reference R1 (at 0.0127 0.0254) (layer F.SilkS) + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_text value 47 (at -3.4925 5.9055 270) (layer F.SilkS) hide + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_line (start 1.524 0.762) (end 0.508 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 1.524 -0.762) (end 1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 0.508 -0.762) (end 1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 -0.762) (end -0.508 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 0.762) (end -1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -0.508 0.762) (end -1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_circle (center -1.651 0.762) (end -1.651 0.635) (layer F.SilkS) (width 0.09906)) + (pad 1 smd rect (at -0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 7 PB1)) + (pad 2 smd rect (at 0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 5 N-000009)) + (model smd/chip_cms.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.1 0.1 0.1)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM0805 (layer F.Cu) (tedit 53FA1491) (tstamp 53F79382) + (at 214.541 155.423 270) + (path /53F78F69) + (attr smd) + (fp_text reference R4 (at -0.0385 -0.0255) (layer F.SilkS) + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_text value 68 (at -5.7916 10.2996 270) (layer F.SilkS) hide + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_line (start 1.524 0.762) (end 0.508 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 1.524 -0.762) (end 1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 0.508 -0.762) (end 1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 -0.762) (end -0.508 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 0.762) (end -1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -0.508 0.762) (end -1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_circle (center -1.651 0.762) (end -1.651 0.635) (layer F.SilkS) (width 0.09906)) + (pad 1 smd rect (at -0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 10 PB4)) + (pad 2 smd rect (at 0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 4 N-000007)) + (model smd/chip_cms.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.1 0.1 0.1)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM0805 (layer F.Cu) (tedit 53FA148B) (tstamp 53F7938F) + (at 212.344 155.372 270) + (path /53F78FA1) + (attr smd) + (fp_text reference R3 (at 0.0506 0.0127) (layer F.SilkS) + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_text value 68 (at -6.4518 8.2423 270) (layer F.SilkS) hide + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_line (start 1.524 0.762) (end 0.508 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 1.524 -0.762) (end 1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 0.508 -0.762) (end 1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 -0.762) (end -0.508 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 0.762) (end -1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -0.508 0.762) (end -1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_circle (center -1.651 0.762) (end -1.651 0.635) (layer F.SilkS) (width 0.09906)) + (pad 1 smd rect (at -0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 9 PB3)) + (pad 2 smd rect (at 0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 3 N-000006)) + (model smd/chip_cms.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.1 0.1 0.1)) + (rotate (xyz 0 0 0)) + ) + ) + + (module SM0805 (layer F.Cu) (tedit 53FA1494) (tstamp 53F7939C) + (at 216.751 155.423 270) + (path /53F78FA7) + (attr smd) + (fp_text reference R2 (at 0.025 0.0128) (layer F.SilkS) + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_text value 1K5 (at -6.325 12.6747 270) (layer F.SilkS) hide + (effects (font (size 0.50038 0.50038) (thickness 0.10922))) + ) + (fp_line (start 1.524 0.762) (end 0.508 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 1.524 -0.762) (end 1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start 0.508 -0.762) (end 1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 -0.762) (end -0.508 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -1.524 0.762) (end -1.524 -0.762) (layer F.SilkS) (width 0.09906)) + (fp_line (start -0.508 0.762) (end -1.524 0.762) (layer F.SilkS) (width 0.09906)) + (fp_circle (center -1.651 0.762) (end -1.651 0.635) (layer F.SilkS) (width 0.09906)) + (pad 1 smd rect (at -0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 13 VCC)) + (pad 2 smd rect (at 0.9525 0 270) (size 0.889 1.397) (layers F.Cu F.Paste F.Mask) + (net 3 N-000006)) + (model smd/chip_cms.wrl + (at (xyz 0 0 0)) + (scale (xyz 0.1 0.1 0.1)) + (rotate (xyz 0 0 0)) + ) + ) + + (module LED-1206 (layer F.Cu) (tedit 53FA1456) (tstamp 53F793C6) + (at 207.162 154.242 90) + (descr "LED 1206 smd package") + (tags "LED1206 SMD") + (path /53F78DB1) + (attr smd) + (fp_text reference D1 (at 0.1148 -2.946 90) (layer F.SilkS) hide + (effects (font (size 0.762 0.762) (thickness 0.0889))) + ) + (fp_text value LED (at 0.1783 -2.8952 90) (layer F.SilkS) hide + (effects (font (size 0.762 0.762) (thickness 0.0889))) + ) + (fp_line (start 1.5494 -0.7493) (end 1.5494 0.7493) (layer F.SilkS) (width 0.1016)) + (fp_line (start -1.5494 -0.7493) (end 1.5494 -0.7493) (layer F.SilkS) (width 0.1016)) + (fp_line (start -1.5494 0.7493) (end -1.5494 -0.7493) (layer F.SilkS) (width 0.1016)) + (fp_line (start 1.5494 0.7493) (end -1.5494 0.7493) (layer F.SilkS) (width 0.1016)) + (fp_line (start 0.44958 0.6985) (end 0.44958 0.44958) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.44958 0.44958) (end 0.59944 0.44958) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.59944 0.6985) (end 0.59944 0.44958) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.44958 0.6985) (end 0.59944 0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.89916 -0.54864) (end -0.89916 -0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.89916 -0.6985) (end -0.79756 -0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.79756 -0.54864) (end -0.79756 -0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.89916 -0.54864) (end -0.79756 -0.54864) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.89916 0.6985) (end -0.89916 -0.49784) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.89916 -0.49784) (end -0.79756 -0.49784) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.79756 0.6985) (end -0.79756 -0.49784) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.89916 0.6985) (end -0.79756 0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 -0.54864) (end 0.79756 -0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 -0.6985) (end 0.89916 -0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.89916 -0.54864) (end 0.89916 -0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 -0.54864) (end 0.89916 -0.54864) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 0.6985) (end 0.79756 -0.49784) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 -0.49784) (end 0.89916 -0.49784) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.89916 0.6985) (end 0.89916 -0.49784) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 0.6985) (end 0.89916 0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.44958 0.6985) (end 0.44958 0.44958) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.44958 0.44958) (end 0.79756 0.44958) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.79756 0.6985) (end 0.79756 0.44958) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.44958 0.6985) (end 0.79756 0.6985) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.09906 0.09906) (end -0.09906 -0.09906) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.09906 -0.09906) (end 0.09906 -0.09906) (layer F.SilkS) (width 0.06604)) + (fp_line (start 0.09906 0.09906) (end 0.09906 -0.09906) (layer F.SilkS) (width 0.06604)) + (fp_line (start -0.09906 0.09906) (end 0.09906 0.09906) (layer F.SilkS) (width 0.06604)) + (fp_arc (start 0 0) (end 0.54864 0.49784) (angle 95.4) (layer F.SilkS) (width 0.1016)) + (fp_arc (start 0 0) (end -0.54864 0.49784) (angle 84.5) (layer F.SilkS) (width 0.1016)) + (fp_arc (start 0 0) (end -0.54864 -0.49784) (angle 95.4) (layer F.SilkS) (width 0.1016)) + (fp_arc (start 0 0) (end 0.54864 -0.49784) (angle 84.5) (layer F.SilkS) (width 0.1016)) + (pad 1 smd rect (at -1.41986 0 90) (size 1.59766 1.80086) (layers F.Cu F.Paste F.Mask) + (net 5 N-000009)) + (pad 2 smd rect (at 1.41986 0 90) (size 1.59766 1.80086) (layers F.Cu F.Paste F.Mask) + (net 1 GND)) + ) + + (gr_line (start 205.0542 157.7594) (end 205.0542 143.1323) (angle 90) (layer Edge.Cuts) (width 0.1)) + (gr_line (start 231.0142 157.7594) (end 231.0142 143.1323) (angle 90) (layer Edge.Cuts) (width 0.1)) + (gr_line (start 205.0542 157.7594) (end 231.0142 157.7594) (angle 90) (layer Edge.Cuts) (width 0.1)) + (gr_line (start 205.0542 143.1323) (end 231.0142 143.1323) (angle 90) (layer Edge.Cuts) (width 0.1)) + + (via (at 208.413 148.8872) (size 0.889) (layers F.Cu B.Cu) (net 1)) + (via (at 207.162 154.2112) (size 0.889) (layers F.Cu B.Cu) (net 1)) + (via (at 207.4421 146.3538) (size 0.889) (layers F.Cu B.Cu) (net 1)) + (via (at 211.4867 147.2913) (size 0.889) (layers F.Cu B.Cu) (net 1)) + (via (at 222.1048 144.0128) (size 0.889) (layers F.Cu B.Cu) (net 1)) + (via (at 223.0533 148.62) (size 0.889) (layers F.Cu B.Cu) (net 1)) + (segment (start 220.2183 153.4024) (end 221.5387 152.082) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 220.2183 154.927) (end 220.2183 153.4024) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.555 152.082) (end 221.5387 152.082) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 219.202 154.927) (end 220.2183 154.927) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 208.0383 150.2539) (end 208.0383 149.2249) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 208.0753 149.2249) (end 208.0383 149.2249) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 208.413 148.8872) (end 208.0753 149.2249) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 212.954 145.3029) (end 212.954 146.7172) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 207.162 152.8221) (end 207.162 154.2112) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 208.0383 144.9961) (end 208.0383 146.0251) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 207.7708 146.0251) (end 208.0383 146.0251) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 207.4421 146.3538) (end 207.7708 146.0251) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 210.579 145.923) (end 210.579 146.4219) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 210.8743 146.7172) (end 211.4867 146.7172) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 210.579 146.4219) (end 210.8743 146.7172) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 211.4867 146.7172) (end 212.954 146.7172) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 211.4867 147.2913) (end 211.4867 146.7172) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.606 145.606) (end 222.606 144.3357) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.4277 144.3357) (end 222.606 144.3357) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.1048 144.0128) (end 222.4277 144.3357) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.085 147.9425) (end 222.085 148.895) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.085 148.895) (end 222.7203 148.895) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.9953 148.62) (end 222.7203 148.895) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 223.0533 148.62) (end 222.9953 148.62) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.7203 150.6464) (end 222.555 150.8117) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.7203 148.895) (end 222.7203 150.6464) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.555 152.082) (end 222.555 151.4468) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.555 151.4468) (end 222.555 150.8117) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 224.5294 153.4212) (end 224.5294 153.9166) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 222.555 151.4468) (end 224.5294 153.4212) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 225.7832 153.9166) (end 224.5294 153.9166) (width 0.254) (layer F.Cu) (net 1)) + (segment (start 219.253 152.082) (end 219.253 150.8117) (width 0.254) (layer F.Cu) (net 2)) + (segment (start 219.545 147.9425) (end 220.1803 147.9425) (width 0.254) (layer F.Cu) (net 2)) + (segment (start 220.1803 150.2171) (end 220.1803 147.9425) (width 0.254) (layer F.Cu) (net 2)) + (segment (start 219.5857 150.8117) (end 220.1803 150.2171) (width 0.254) (layer F.Cu) (net 2)) + (segment (start 219.253 150.8117) (end 219.5857 150.8117) (width 0.254) (layer F.Cu) (net 2)) + (segment (start 216.751 156.3755) (end 216.751 156.0261) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 225.7832 149.3928) (end 224.5294 149.3928) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 217.3344 156.6095) (end 216.751 156.0261) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 225.0662 156.6095) (end 217.3344 156.6095) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 227.037 154.6387) (end 225.0662 156.6095) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 227.037 153.2119) (end 227.037 154.6387) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 226.888 153.0629) (end 227.037 153.2119) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 225.3961 153.0629) (end 226.888 153.0629) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 224.5294 152.1962) (end 225.3961 153.0629) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 224.5294 149.3928) (end 224.5294 152.1962) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 213.2968 156.0814) (end 213.2968 156.3245) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 213.7016 155.6766) (end 213.2968 156.0814) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 216.4015 155.6766) (end 213.7016 155.6766) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 216.751 156.0261) (end 216.4015 155.6766) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 212.344 156.3245) (end 213.2968 156.3245) (width 0.254) (layer F.Cu) (net 3)) + (segment (start 214.541 156.3755) (end 214.541 157.0743) (width 0.254) (layer F.Cu) (net 4)) + (segment (start 225.7832 151.4452) (end 227.037 151.4452) (width 0.254) (layer F.Cu) (net 4)) + (segment (start 227.4183 151.8265) (end 227.037 151.4452) (width 0.254) (layer F.Cu) (net 4)) + (segment (start 227.4183 154.7966) (end 227.4183 151.8265) (width 0.254) (layer F.Cu) (net 4)) + (segment (start 225.1406 157.0743) (end 227.4183 154.7966) (width 0.254) (layer F.Cu) (net 4)) + (segment (start 214.541 157.0743) (end 225.1406 157.0743) (width 0.254) (layer F.Cu) (net 4)) + (segment (start 208.6206 155.6619) (end 209.2322 156.2735) (width 0.254) (layer F.Cu) (net 5)) + (segment (start 207.162 155.6619) (end 208.6206 155.6619) (width 0.254) (layer F.Cu) (net 5)) + (segment (start 210.185 156.2735) (end 209.2322 156.2735) (width 0.254) (layer F.Cu) (net 5)) + (via (at 212.0719 151.4767) (size 0.889) (layers F.Cu B.Cu) (net 6)) + (segment (start 212.954 152.1051) (end 212.954 150.6908) (width 0.254) (layer F.Cu) (net 6)) + (segment (start 213.8304 151.4767) (end 212.0719 151.4767) (width 0.254) (layer B.Cu) (net 6)) + (segment (start 214.0677 151.714) (end 213.8304 151.4767) (width 0.254) (layer B.Cu) (net 6)) + (segment (start 212.0719 151.1411) (end 212.0719 151.4767) (width 0.254) (layer F.Cu) (net 6)) + (segment (start 212.5222 150.6908) (end 212.0719 151.1411) (width 0.254) (layer F.Cu) (net 6)) + (segment (start 212.954 150.6908) (end 212.5222 150.6908) (width 0.254) (layer F.Cu) (net 6)) + (segment (start 215.722 151.714) (end 214.0677 151.714) (width 0.254) (layer B.Cu) (net 6)) + (via (at 213.4489 150.0759) (size 0.889) (layers F.Cu B.Cu) (net 7)) + (segment (start 215.1663 153.5194) (end 214.224 153.5194) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 215.4939 153.847) (end 215.1663 153.5194) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 215.4939 155.0233) (end 215.4939 153.847) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 215.3478 155.1694) (end 215.4939 155.0233) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 210.2871 155.1694) (end 215.3478 155.1694) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 210.185 155.0673) (end 210.2871 155.1694) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 210.185 154.3685) (end 210.185 155.0673) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 214.224 152.1051) (end 214.224 150.6908) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 214.0677 149.701) (end 213.4489 150.0759) (width 0.254) (layer B.Cu) (net 7)) + (segment (start 214.0677 149.174) (end 214.0677 149.701) (width 0.254) (layer B.Cu) (net 7)) + (segment (start 214.224 150.5385) (end 213.4489 150.0759) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 214.224 150.6908) (end 214.224 150.5385) (width 0.254) (layer F.Cu) (net 7)) + (segment (start 215.722 149.174) (end 214.0677 149.174) (width 0.254) (layer B.Cu) (net 7)) + (segment (start 214.224 152.1051) (end 214.224 153.5194) (width 0.254) (layer F.Cu) (net 7)) + (via (at 212.2994 149.7861) (size 0.889) (layers F.Cu B.Cu) (net 8)) + (via (at 206.1128 148.735) (size 0.889) (layers F.Cu B.Cu) (net 8)) + (segment (start 215.494 152.1051) (end 215.494 150.6908) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 215.722 146.634) (end 214.0677 146.634) (width 0.254) (layer B.Cu) (net 8)) + (segment (start 212.2994 149.5861) (end 212.2994 149.7861) (width 0.254) (layer B.Cu) (net 8)) + (segment (start 214.0677 147.8178) (end 212.2994 149.5861) (width 0.254) (layer B.Cu) (net 8)) + (segment (start 214.0677 146.634) (end 214.0677 147.8178) (width 0.254) (layer B.Cu) (net 8)) + (segment (start 206.9639 149.5861) (end 206.1128 148.735) (width 0.254) (layer B.Cu) (net 8)) + (segment (start 212.2994 149.5861) (end 206.9639 149.5861) (width 0.254) (layer B.Cu) (net 8)) + (segment (start 206.2857 148.9079) (end 206.2857 150.2539) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 206.1128 148.735) (end 206.2857 148.9079) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 206.4441 148.4037) (end 206.1128 148.735) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 206.4441 146.1835) (end 206.4441 148.4037) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 206.2857 146.0251) (end 206.4441 146.1835) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 206.2857 144.9961) (end 206.2857 146.0251) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 212.7427 149.3428) (end 212.2994 149.7861) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 214.146 149.3428) (end 212.7427 149.3428) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 215.494 150.6908) (end 214.146 149.3428) (width 0.254) (layer F.Cu) (net 8)) + (segment (start 210.395 143.8886) (end 215.494 143.8886) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 208.909 145.3746) (end 210.395 143.8886) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 208.909 146.3325) (end 208.909 145.3746) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 207.2371 148.0044) (end 208.909 146.3325) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 207.2371 151.1208) (end 207.2371 148.0044) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 207.8852 151.7689) (end 207.2371 151.1208) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 209.6934 151.7689) (end 207.8852 151.7689) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 212.344 154.4195) (end 209.6934 151.7689) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 215.494 145.3029) (end 215.494 143.8886) (width 0.254) (layer F.Cu) (net 9)) + (segment (start 212.9231 148.0181) (end 214.224 146.7172) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 209.6325 148.0181) (end 212.9231 148.0181) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 209.3086 148.342) (end 209.6325 148.0181) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 209.3086 150.325) (end 209.3086 148.342) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 212.7043 153.7207) (end 209.3086 150.325) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 213.7912 153.7207) (end 212.7043 153.7207) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 214.541 154.4705) (end 213.7912 153.7207) (width 0.254) (layer F.Cu) (net 10)) + (segment (start 214.224 145.3029) (end 214.224 146.7172) (width 0.254) (layer F.Cu) (net 10)) + (via (at 219.1995 144.0085) (size 0.889) (layers F.Cu B.Cu) (net 11)) + (segment (start 216.764 145.3029) (end 216.764 143.8886) (width 0.254) (layer F.Cu) (net 11)) + (segment (start 219.114 144.094) (end 219.1995 144.0085) (width 0.254) (layer B.Cu) (net 11)) + (segment (start 215.722 144.094) (end 219.114 144.094) (width 0.254) (layer B.Cu) (net 11)) + (segment (start 219.0796 143.8886) (end 219.1995 144.0085) (width 0.254) (layer F.Cu) (net 11)) + (segment (start 216.764 143.8886) (end 219.0796 143.8886) (width 0.254) (layer F.Cu) (net 11)) + (segment (start 219.304 145.606) (end 220.3203 145.606) (width 0.254) (layer F.Cu) (net 12)) + (segment (start 221.4497 147.1074) (end 221.6357 146.9214) (width 0.254) (layer F.Cu) (net 12)) + (segment (start 221.4497 149.8475) (end 221.4497 147.1074) (width 0.254) (layer F.Cu) (net 12)) + (segment (start 220.3203 145.606) (end 221.6357 146.9214) (width 0.254) (layer F.Cu) (net 12)) + (segment (start 221.6357 146.9214) (end 225.7832 146.9214) (width 0.254) (layer F.Cu) (net 12)) + (segment (start 222.085 149.8475) (end 221.4497 149.8475) (width 0.254) (layer F.Cu) (net 12)) + (via (at 217.7418 153.4713) (size 0.889) (layers F.Cu B.Cu) (net 13)) + (segment (start 216.751 154.4705) (end 216.751 153.7717) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 217.266 155.1693) (end 216.751 155.1693) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 218.2962 156.1995) (end 217.266 155.1693) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 220.2152 156.1995) (end 218.2962 156.1995) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 221.4877 154.927) (end 220.2152 156.1995) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 222.504 154.927) (end 221.4877 154.927) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 216.751 154.4705) (end 216.751 155.1693) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 219.545 149.8475) (end 218.9097 149.8475) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 218.0664 150.6908) (end 218.9097 149.8475) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 216.764 150.6908) (end 218.0664 150.6908) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 216.764 152.1051) (end 216.764 150.6908) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 210.579 149.225) (end 211.8493 149.225) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 212.1128 148.9615) (end 211.8493 149.225) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 215.0347 148.9615) (end 212.1128 148.9615) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 216.764 150.6908) (end 215.0347 148.9615) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 216.764 152.1051) (end 216.764 153.5194) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 217.3763 153.8368) (end 217.7418 153.4713) (width 0.254) (layer B.Cu) (net 13)) + (segment (start 217.3763 156.794) (end 217.3763 153.8368) (width 0.254) (layer B.Cu) (net 13)) + (segment (start 216.764 153.7587) (end 216.751 153.7717) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 216.764 153.5194) (end 216.764 153.7587) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 217.6937 153.5194) (end 216.764 153.5194) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 217.7418 153.4713) (end 217.6937 153.5194) (width 0.254) (layer F.Cu) (net 13)) + (segment (start 215.722 156.794) (end 217.3763 156.794) (width 0.254) (layer B.Cu) (net 13)) + + (zone (net 1) (net_name GND) (layer B.Cu) (tstamp 53FA13A2) (hatch edge 0.508) + (connect_pads (clearance 0.254)) + (min_thickness 0.127) + (fill (arc_segments 16) (thermal_gap 0.254) (thermal_bridge_width 0.254)) + (polygon + (pts + (xy 205.0415 143.1544) (xy 231.0257 143.1671) (xy 230.9876 157.7721) (xy 205.0415 157.7086) + ) + ) + (filled_polygon + (pts + (xy 230.6467 157.3919) (xy 230.204154 157.3919) (xy 230.204154 156.26862) (xy 230.204154 144.56938) (xy 230.122949 144.161133) + (xy 229.891696 143.815038) (xy 229.545601 143.583785) (xy 229.137354 143.50258) (xy 227.565006 143.50258) (xy 227.156759 143.583785) + (xy 226.810664 143.815038) (xy 226.579411 144.161133) (xy 226.498206 144.56938) (xy 226.579411 144.977627) (xy 226.810664 145.323722) + (xy 227.156759 145.554975) (xy 227.565006 145.63618) (xy 229.137354 145.63618) (xy 229.545601 145.554975) (xy 229.891696 145.323722) + (xy 230.122949 144.977627) (xy 230.204154 144.56938) (xy 230.204154 156.26862) (xy 230.122949 155.860373) (xy 229.891696 155.514278) + (xy 229.545601 155.283025) (xy 229.170569 155.208426) (xy 229.170569 152.487481) (xy 229.150249 152.438302) (xy 229.150249 148.004381) + (xy 229.018458 147.685423) (xy 228.77464 147.441179) (xy 228.455913 147.308832) (xy 228.110801 147.308531) (xy 227.791843 147.440322) + (xy 227.547599 147.68414) (xy 227.415252 148.002867) (xy 227.414951 148.347979) (xy 227.546742 148.666937) (xy 227.79056 148.911181) + (xy 228.109287 149.043528) (xy 228.454399 149.043829) (xy 228.773357 148.912038) (xy 229.017601 148.66822) (xy 229.149948 148.349493) + (xy 229.150249 148.004381) (xy 229.150249 152.438302) (xy 229.038778 152.168523) (xy 228.79496 151.924279) (xy 228.476233 151.791932) + (xy 228.131121 151.791631) (xy 227.812163 151.923422) (xy 227.567919 152.16724) (xy 227.435572 152.485967) (xy 227.435271 152.831079) + (xy 227.567062 153.150037) (xy 227.81088 153.394281) (xy 228.129607 153.526628) (xy 228.474719 153.526929) (xy 228.793677 153.395138) + (xy 229.037921 153.15132) (xy 229.170268 152.832593) (xy 229.170569 152.487481) (xy 229.170569 155.208426) (xy 229.137354 155.20182) + (xy 227.565006 155.20182) (xy 227.156759 155.283025) (xy 226.810664 155.514278) (xy 226.579411 155.860373) (xy 226.498206 156.26862) + (xy 226.579411 156.676867) (xy 226.810664 157.022962) (xy 227.156759 157.254215) (xy 227.565006 157.33542) (xy 229.137354 157.33542) + (xy 229.545601 157.254215) (xy 229.891696 157.022962) (xy 230.122949 156.676867) (xy 230.204154 156.26862) (xy 230.204154 157.3919) + (xy 217.439555 157.3919) (xy 217.439555 157.225917) (xy 217.546403 157.204664) (xy 217.690609 157.108309) (xy 217.786964 156.964103) + (xy 217.8208 156.794) (xy 217.8208 154.233369) (xy 217.892706 154.233432) (xy 218.172874 154.117668) (xy 218.387415 153.903502) + (xy 218.503667 153.623536) (xy 218.503932 153.320394) (xy 218.388168 153.040226) (xy 218.174002 152.825685) (xy 217.894036 152.709433) + (xy 217.590894 152.709168) (xy 217.352248 152.807775) (xy 217.391007 152.769084) (xy 217.439445 152.652431) (xy 217.439555 152.526122) + (xy 217.439555 150.776122) (xy 217.39132 150.659385) (xy 217.302084 150.569993) (xy 217.185431 150.521555) (xy 217.059122 150.521445) + (xy 214.259122 150.521445) (xy 214.142385 150.56968) (xy 214.052993 150.658916) (xy 214.004555 150.775569) (xy 214.004445 150.901878) + (xy 214.004445 151.068669) (xy 214.000503 151.066036) (xy 213.8304 151.0322) (xy 212.704865 151.0322) (xy 212.504102 150.831085) + (xy 212.224136 150.714833) (xy 211.920994 150.714568) (xy 211.640826 150.830332) (xy 211.426285 151.044498) (xy 211.310033 151.324464) + (xy 211.309768 151.627606) (xy 211.425532 151.907774) (xy 211.639698 152.122315) (xy 211.919664 152.238567) (xy 212.222806 152.238832) + (xy 212.502974 152.123068) (xy 212.705195 151.9212) (xy 213.646281 151.9212) (xy 213.75339 152.028308) (xy 213.753391 152.028309) + (xy 213.897597 152.124664) (xy 214.004445 152.145917) (xy 214.004445 152.651878) (xy 214.05268 152.768615) (xy 214.141916 152.858007) + (xy 214.258569 152.906445) (xy 214.384878 152.906555) (xy 217.184878 152.906555) (xy 217.260092 152.875476) (xy 217.096185 153.039098) + (xy 217.086895 153.061469) (xy 217.059122 153.061445) (xy 215.864875 153.0615) (xy 215.7855 153.140875) (xy 215.7855 154.1905) + (xy 215.8055 154.1905) (xy 215.8055 154.3175) (xy 215.7855 154.3175) (xy 215.7855 155.367125) (xy 215.864875 155.4465) + (xy 216.9318 155.446549) (xy 216.9318 155.601445) (xy 215.6585 155.601445) (xy 215.6585 155.367125) (xy 215.6585 154.3175) + (xy 215.6585 154.1905) (xy 215.6585 153.140875) (xy 215.579125 153.0615) (xy 214.384878 153.061445) (xy 214.258569 153.061555) + (xy 214.141916 153.109993) (xy 214.05268 153.199385) (xy 214.004445 153.316122) (xy 214.0045 154.111125) (xy 214.083875 154.1905) + (xy 215.6585 154.1905) (xy 215.6585 154.3175) (xy 214.083875 154.3175) (xy 214.0045 154.396875) (xy 214.004445 155.191878) + (xy 214.05268 155.308615) (xy 214.141916 155.398007) (xy 214.258569 155.446445) (xy 214.384878 155.446555) (xy 215.579125 155.4465) + (xy 215.6585 155.367125) (xy 215.6585 155.601445) (xy 214.259122 155.601445) (xy 214.142385 155.64968) (xy 214.052993 155.738916) + (xy 214.004555 155.855569) (xy 214.004445 155.981878) (xy 214.004445 157.3919) (xy 205.4217 157.3919) (xy 205.4217 149.057815) + (xy 205.466432 149.166074) (xy 205.680598 149.380615) (xy 205.960564 149.496867) (xy 206.246298 149.497116) (xy 206.649591 149.900409) + (xy 206.793797 149.996764) (xy 206.793798 149.996764) (xy 206.9639 150.0306) (xy 211.57594 150.0306) (xy 211.653032 150.217174) + (xy 211.867198 150.431715) (xy 212.147164 150.547967) (xy 212.450306 150.548232) (xy 212.730474 150.432468) (xy 212.759694 150.403299) + (xy 212.802532 150.506974) (xy 213.016698 150.721515) (xy 213.296664 150.837767) (xy 213.599806 150.838032) (xy 213.879974 150.722268) + (xy 214.094515 150.508102) (xy 214.168811 150.329175) (xy 214.258569 150.366445) (xy 214.384878 150.366555) (xy 217.184878 150.366555) + (xy 217.301615 150.31832) (xy 217.391007 150.229084) (xy 217.439445 150.112431) (xy 217.439555 149.986122) (xy 217.439555 148.236122) + (xy 217.39132 148.119385) (xy 217.302084 148.029993) (xy 217.185431 147.981555) (xy 217.059122 147.981445) (xy 214.479648 147.981445) + (xy 214.510458 147.826555) (xy 217.184878 147.826555) (xy 217.301615 147.77832) (xy 217.391007 147.689084) (xy 217.439445 147.572431) + (xy 217.439555 147.446122) (xy 217.439555 145.696122) (xy 217.39132 145.579385) (xy 217.302084 145.489993) (xy 217.185431 145.441555) + (xy 217.059122 145.441445) (xy 214.259122 145.441445) (xy 214.142385 145.48968) (xy 214.052993 145.578916) (xy 214.004555 145.695569) + (xy 214.004445 145.821878) (xy 214.004445 146.202082) (xy 213.897597 146.223336) (xy 213.753391 146.319691) (xy 213.657036 146.463897) + (xy 213.6232 146.634) (xy 213.6232 147.633682) (xy 212.23284 149.024041) (xy 212.148494 149.023968) (xy 211.868326 149.139732) + (xy 211.866454 149.1416) (xy 209.252541 149.1416) (xy 209.252541 147.468889) (xy 209.146424 147.212069) (xy 208.950105 147.015406) + (xy 208.69347 146.908842) (xy 208.415589 146.908599) (xy 208.158769 147.014716) (xy 207.962106 147.211035) (xy 207.855542 147.46767) + (xy 207.855299 147.745551) (xy 207.961416 148.002371) (xy 208.157735 148.199034) (xy 208.41437 148.305598) (xy 208.692251 148.305841) + (xy 208.949071 148.199724) (xy 209.145734 148.003405) (xy 209.252298 147.74677) (xy 209.252541 147.468889) (xy 209.252541 149.1416) + (xy 207.148018 149.1416) (xy 206.874683 148.868265) (xy 206.874932 148.584094) (xy 206.759168 148.303926) (xy 206.545002 148.089385) + (xy 206.378179 148.020114) (xy 206.392374 148.005945) (xy 206.498938 147.74931) (xy 206.499181 147.471429) (xy 206.393064 147.214609) + (xy 206.196745 147.017946) (xy 205.94011 146.911382) (xy 205.662229 146.911139) (xy 205.4217 147.010524) (xy 205.4217 143.4998) + (xy 214.004445 143.4998) (xy 214.004445 145.031878) (xy 214.05268 145.148615) (xy 214.141916 145.238007) (xy 214.258569 145.286445) + (xy 214.384878 145.286555) (xy 217.184878 145.286555) (xy 217.301615 145.23832) (xy 217.391007 145.149084) (xy 217.439445 145.032431) + (xy 217.439555 144.906122) (xy 217.439555 144.5385) (xy 218.651885 144.5385) (xy 218.767298 144.654115) (xy 219.047264 144.770367) + (xy 219.350406 144.770632) (xy 219.630574 144.654868) (xy 219.845115 144.440702) (xy 219.961367 144.160736) (xy 219.961632 143.857594) + (xy 219.845868 143.577426) (xy 219.768377 143.4998) (xy 230.6467 143.4998) (xy 230.6467 157.3919) + ) + ) + ) +) diff --git a/classic/hw/classic-v1.net b/classic/hw/classic-v1.net new file mode 100644 index 0000000..ed66577 --- /dev/null +++ b/classic/hw/classic-v1.net @@ -0,0 +1,277 @@ +(export (version D) + (design + (source "classic-v1.sch") + (date "8/14/2020 1:20:06 PM") + (tool "Eeschema (5.1.6)-1") + (sheet (number 1) (name /) (tstamps /) + (title_block + (title) + (company) + (rev) + (date "22 aug 2014") + (source classic-v1.sch) + (comment (number 1) (value "")) + (comment (number 2) (value "")) + (comment (number 3) (value "")) + (comment (number 4) (value ""))))) + (components + (comp (ref U1) + (value ATTINY85) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part ATTINY85) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78C6C)) + (comp (ref U2) + (value LDO) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part LDO) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78C7B)) + (comp (ref J2) + (value USB) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part USB) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78CBD)) + (comp (ref J1) + (value ISP) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part ISP) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78CDD)) + (comp (ref SW1) + (value ESWITCH) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part ESWITCH) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78CF3)) + (comp (ref C1) + (value 10uF) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part CP1) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78D86)) + (comp (ref R1) + (value 47) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part R) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78DA1)) + (comp (ref D1) + (value LED) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part LED) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78DB1)) + (comp (ref C3) + (value .01uF) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part C) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78DE2)) + (comp (ref C2) + (value .1uF) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part C) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78E1D)) + (comp (ref C4) + (value 1uF) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part CP1) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78E77)) + (comp (ref R4) + (value 68) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part R) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78F69)) + (comp (ref R3) + (value 68) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part R) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78FA1)) + (comp (ref R2) + (value 1K5) + (footprint ~) + (datasheet ~) + (libsource (lib classic-v1-rescue) (part R) (description "")) + (sheetpath (names /) (tstamps /)) + (tstamp 53F78FA7))) + (libparts + (libpart (lib classic-v1-rescue) (part ATTINY85) + (fields + (field (name Reference) U) + (field (name Value) ATTINY85)) + (pins + (pin (num 1) (name PB5/NRES) (type BiDi)) + (pin (num 2) (name PB3/ADC1) (type BiDi)) + (pin (num 3) (name PB4/ADC2) (type BiDi)) + (pin (num 4) (name GND) (type power_out)) + (pin (num 5) (name PB0/MOSI) (type BiDi)) + (pin (num 6) (name PB1/MISO) (type BiDi)) + (pin (num 7) (name PB2/SCK/ADC1) (type BiDi)) + (pin (num 8) (name VCC) (type power_in)))) + (libpart (lib classic-v1-rescue) (part C) + (footprints + (fp SM*) + (fp C?) + (fp C1-1)) + (fields + (field (name Reference) C) + (field (name Value) C)) + (pins + (pin (num 1) (name ~) (type passive)) + (pin (num 2) (name ~) (type passive)))) + (libpart (lib classic-v1-rescue) (part CP1) + (footprints + (fp CP*) + (fp SM*)) + (fields + (field (name Reference) C) + (field (name Value) CP1)) + (pins + (pin (num 1) (name ~) (type passive)) + (pin (num 2) (name ~) (type passive)))) + (libpart (lib classic-v1-rescue) (part ESWITCH) + (fields + (field (name Reference) SW) + (field (name Value) ESWITCH)) + (pins + (pin (num 1) (name ~) (type passive)) + (pin (num 2) (name ~) (type passive)))) + (libpart (lib classic-v1-rescue) (part ISP) + (fields + (field (name Reference) J) + (field (name Value) ISP)) + (pins + (pin (num 1) (name MISO) (type power_in)) + (pin (num 2) (name +VCC) (type power_out)) + (pin (num 3) (name SCK) (type BiDi)) + (pin (num 4) (name MOSI) (type BiDi)) + (pin (num 5) (name RESET) (type BiDi)) + (pin (num 6) (name GND) (type BiDi)))) + (libpart (lib classic-v1-rescue) (part LDO) + (fields + (field (name Reference) U) + (field (name Value) LDO)) + (pins + (pin (num 1) (name IN) (type power_in)) + (pin (num 2) (name GND) (type power_out)) + (pin (num 3) (name EN) (type input)) + (pin (num 4) (name BP) (type passive)) + (pin (num 5) (name OUT) (type power_out)))) + (libpart (lib classic-v1-rescue) (part LED) + (footprints + (fp LED-3MM) + (fp LED-5MM) + (fp LED-10MM) + (fp LED-0603) + (fp LED-0805) + (fp LED-1206) + (fp LEDV)) + (fields + (field (name Reference) D) + (field (name Value) LED)) + (pins + (pin (num 1) (name A) (type passive)) + (pin (num 2) (name K) (type passive)))) + (libpart (lib classic-v1-rescue) (part R) + (footprints + (fp R?) + (fp SM0603) + (fp SM0805) + (fp R?-*) + (fp SM1206)) + (fields + (field (name Reference) R) + (field (name Value) R)) + (pins + (pin (num 1) (name ~) (type passive)) + (pin (num 2) (name ~) (type passive)))) + (libpart (lib classic-v1-rescue) (part USB) + (fields + (field (name Reference) J) + (field (name Value) USB)) + (pins + (pin (num 1) (name GND) (type power_out)) + (pin (num 2) (name D+) (type BiDi)) + (pin (num 3) (name D-) (type BiDi)) + (pin (num 4) (name VBUS) (type power_in))))) + (libraries + (library (logical classic-v1-rescue) + (uri "classic-v1-rescue.lib"))) + (nets + (net (code 1) (name PB2) + (node (ref SW1) (pin 1)) + (node (ref SW1) (pin 1)) + (node (ref J1) (pin 3)) + (node (ref U1) (pin 7))) + (net (code 2) (name VCC) + (node (ref U2) (pin 5)) + (node (ref C1) (pin 1)) + (node (ref C4) (pin 1)) + (node (ref R2) (pin 1)) + (node (ref J1) (pin 2)) + (node (ref U1) (pin 8))) + (net (code 3) (name PB3) + (node (ref U1) (pin 2)) + (node (ref R3) (pin 1))) + (net (code 4) (name PB4) + (node (ref R4) (pin 1)) + (node (ref U1) (pin 3))) + (net (code 5) (name PB5) + (node (ref U1) (pin 1)) + (node (ref J1) (pin 5))) + (net (code 6) (name GND) + (node (ref J2) (pin 1)) + (node (ref D1) (pin 2)) + (node (ref C1) (pin 2)) + (node (ref SW1) (pin 2)) + (node (ref U2) (pin 3)) + (node (ref C2) (pin 2)) + (node (ref C4) (pin 2)) + (node (ref U2) (pin 2)) + (node (ref C3) (pin 2)) + (node (ref U1) (pin 4)) + (node (ref J1) (pin 6)) + (node (ref SW1) (pin 2))) + (net (code 7) (name PB1) + (node (ref R1) (pin 1)) + (node (ref U1) (pin 6)) + (node (ref J1) (pin 1))) + (net (code 8) (name PB0) + (node (ref J1) (pin 4)) + (node (ref U1) (pin 5))) + (net (code 9) (name "Net-(J2-Pad3)") + (node (ref R3) (pin 2)) + (node (ref R2) (pin 2)) + (node (ref J2) (pin 3))) + (net (code 10) (name "Net-(D1-Pad1)") + (node (ref R1) (pin 2)) + (node (ref D1) (pin 1))) + (net (code 11) (name "Net-(J2-Pad2)") + (node (ref J2) (pin 2)) + (node (ref R4) (pin 2))) + (net (code 12) (name "Net-(C3-Pad1)") + (node (ref U2) (pin 4)) + (node (ref C3) (pin 1))) + (net (code 13) (name VBUS) + (node (ref J2) (pin 4)) + (node (ref C2) (pin 1)) + (node (ref U2) (pin 1))))) \ No newline at end of file diff --git a/classic/hw/classic-v1.pdf b/classic/hw/classic-v1.pdf new file mode 100644 index 0000000..27d21ca Binary files /dev/null and b/classic/hw/classic-v1.pdf differ diff --git a/classic/hw/classic-v1.pro b/classic/hw/classic-v1.pro new file mode 100644 index 0000000..9fa93b6 --- /dev/null +++ b/classic/hw/classic-v1.pro @@ -0,0 +1,32 @@ +update=8/14/2020 1:13:33 PM +version=1 +last_client=kicad +[cvpcb] +version=1 +NetIExt=net +[cvpcb/libraries] +EquName1=devcms +[general] +version=1 +[pcbnew] +version=1 +LastNetListRead= +UseCmpFile=1 +PadDrill=0.600000000000 +PadDrillOvalY=0.600000000000 +PadSizeH=1.500000000000 +PadSizeV=1.500000000000 +PcbTextSizeV=1.500000000000 +PcbTextSizeH=1.500000000000 +PcbTextThickness=0.300000000000 +ModuleTextSizeV=1.000000000000 +ModuleTextSizeH=1.000000000000 +ModuleTextSizeThickness=0.150000000000 +SolderMaskClearance=0.000000000000 +SolderMaskMinWidth=0.000000000000 +DrawSegmentWidth=0.200000000000 +BoardOutlineThickness=0.100000000000 +ModuleOutlineThickness=0.150000000000 +[eeschema] +version=1 +LibDir= diff --git a/classic/hw/classic-v1.sch b/classic/hw/classic-v1.sch new file mode 100644 index 0000000..4340bd5 --- /dev/null +++ b/classic/hw/classic-v1.sch @@ -0,0 +1,337 @@ +EESchema Schematic File Version 4 +EELAYER 30 0 +EELAYER END +$Descr A4 11693 8268 +encoding utf-8 +Sheet 1 1 +Title "" +Date "22 aug 2014" +Rev "" +Comp "" +Comment1 "" +Comment2 "" +Comment3 "" +Comment4 "" +$EndDescr +$Comp +L classic-v1-rescue:ATTINY85 U1 +U 1 1 53F78C6C +P 4000 3550 +F 0 "U1" H 3950 3550 60 0000 C CNN +F 1 "ATTINY85" H 4000 4300 60 0000 C CNN +F 2 "~" H 4000 3550 60 0000 C CNN +F 3 "~" H 4000 3550 60 0000 C CNN + 1 4000 3550 + 1 0 0 -1 +$EndComp +$Comp +L classic-v1-rescue:LDO U2 +U 1 1 53F78C7B +P 8500 2000 +F 0 "U2" H 8300 2350 60 0000 C CNN +F 1 "LDO" H 8500 1650 60 0000 C CNN +F 2 "~" H 7700 2650 60 0000 C CNN +F 3 "~" H 7700 2650 60 0000 C CNN + 1 8500 2000 + 1 0 0 -1 +$EndComp +$Comp +L classic-v1-rescue:USB J2 +U 1 1 53F78CBD +P 9200 4000 +F 0 "J2" H 9200 3650 60 0000 C CNN +F 1 "USB" H 9200 3750 60 0000 C CNN +F 2 "~" H 9200 4000 60 0000 C CNN +F 3 "~" H 9200 4000 60 0000 C CNN + 1 9200 4000 + 0 -1 -1 0 +$EndComp +$Comp +L classic-v1-rescue:ISP J1 +U 1 1 53F78CDD +P 8500 5750 +F 0 "J1" H 8250 6350 60 0000 C CNN +F 1 "ISP" H 8300 5200 60 0000 C CNN +F 2 "~" H 8500 5750 60 0000 C CNN +F 3 "~" H 8500 5750 60 0000 C CNN + 1 8500 5750 + 1 0 0 -1 +$EndComp +$Comp +L classic-v1-rescue:ESWITCH SW1 +U 1 1 53F78CF3 +P 4150 6750 +F 0 "SW1" H 4050 7000 60 0000 C CNN +F 1 "ESWITCH" H 4150 6500 60 0000 C CNN +F 2 "~" H 3400 7450 60 0000 C CNN +F 3 "~" H 3400 7450 60 0000 C CNN + 1 4150 6750 + 1 0 0 -1 +$EndComp +$Comp +L classic-v1-rescue:CP1 C1 +U 1 1 53F78D86 +P 3000 3800 +F 0 "C1" H 3050 3900 50 0000 L CNN +F 1 "10uF" H 3050 3700 50 0000 L CNN +F 2 "~" H 3000 3800 60 0000 C CNN +F 3 "~" H 3000 3800 60 0000 C CNN + 1 3000 3800 + 1 0 0 -1 +$EndComp +$Comp +L classic-v1-rescue:R R1 +U 1 1 53F78DA1 +P 1850 6800 +F 0 "R1" V 1930 6800 40 0000 C CNN +F 1 "47" V 1857 6801 40 0000 C CNN +F 2 "~" V 1780 6800 30 0000 C CNN +F 3 "~" H 1850 6800 30 0000 C CNN + 1 1850 6800 + 0 -1 -1 0 +$EndComp +$Comp +L classic-v1-rescue:LED D1 +U 1 1 53F78DB1 +P 2400 6800 +F 0 "D1" H 2400 6900 50 0000 C CNN +F 1 "LED" H 2400 6700 50 0000 C CNN +F 2 "~" H 2400 6800 60 0000 C CNN +F 3 "~" H 2400 6800 60 0000 C CNN + 1 2400 6800 + 1 0 0 -1 +$EndComp +$Comp +L classic-v1-rescue:C C3 +U 1 1 53F78DE2 +P 8500 2500 +F 0 "C3" H 8500 2600 40 0000 L CNN +F 1 ".01uF" H 8506 2415 40 0000 L CNN +F 2 "~" H 8538 2350 30 0000 C CNN +F 3 "~" H 8500 2500 60 0000 C CNN + 1 8500 2500 + 0 1 1 0 +$EndComp +Wire Wire Line + 8700 2500 9050 2500 +Wire Wire Line + 9050 2500 9050 2150 +Wire Wire Line + 7700 2500 7950 2500 +Wire Wire Line + 7950 2000 7950 2150 +Connection ~ 7950 2150 +$Comp +L classic-v1-rescue:C C2 +U 1 1 53F78E1D +P 7700 2300 +F 0 "C2" H 7700 2400 40 0000 L CNN +F 1 ".1uF" H 7706 2215 40 0000 L CNN +F 2 "~" H 7738 2150 30 0000 C CNN +F 3 "~" H 7700 2300 60 0000 C CNN + 1 7700 2300 + 1 0 0 -1 +$EndComp +Connection ~ 7950 2500 +Wire Wire Line + 7700 1500 7700 1850 +Wire Wire Line + 7700 1850 7950 1850 +Text GLabel 9500 2700 2 60 Input ~ 0 +GND +Wire Wire Line + 7700 2700 7700 2500 +$Comp +L classic-v1-rescue:CP1 C4 +U 1 1 53F78E77 +P 9200 2050 +F 0 "C4" H 9250 2150 50 0000 L CNN +F 1 "1uF" H 9250 1950 50 0000 L CNN +F 2 "~" H 9200 2050 60 0000 C CNN +F 3 "~" H 9200 2050 60 0000 C CNN + 1 9200 2050 + 1 0 0 -1 +$EndComp +Wire Wire Line + 9050 1850 9200 1850 +Wire Wire Line + 9200 2250 9200 2700 +Text GLabel 9450 1850 2 60 Input ~ 0 +VCC +Connection ~ 9200 1850 +Wire Wire Line + 7700 2700 9200 2700 +Connection ~ 9200 2700 +Text GLabel 9450 1500 2 60 Input ~ 0 +VBUS +Wire Wire Line + 9450 1500 7700 1500 +Connection ~ 7700 1850 +Text GLabel 8700 4250 3 60 Input ~ 0 +GND +Text GLabel 8550 4250 3 60 Input ~ 0 +VBUS +Wire Wire Line + 8700 4250 8700 4150 +Wire Wire Line + 8700 4150 8850 4150 +Wire Wire Line + 8550 4250 8550 4050 +Wire Wire Line + 8550 4050 8850 4050 +$Comp +L classic-v1-rescue:R R4 +U 1 1 53F78F69 +P 8500 3950 +F 0 "R4" V 8580 3950 40 0000 C CNN +F 1 "68" V 8507 3951 40 0000 C CNN +F 2 "~" V 8430 3950 30 0000 C CNN +F 3 "~" H 8500 3950 30 0000 C CNN + 1 8500 3950 + 0 -1 -1 0 +$EndComp +Wire Wire Line + 8850 3950 8750 3950 +Text GLabel 8250 4250 3 60 Input ~ 0 +PB4 +Wire Wire Line + 8250 4250 8250 3950 +$Comp +L classic-v1-rescue:R R3 +U 1 1 53F78FA1 +P 8500 3800 +F 0 "R3" V 8580 3800 40 0000 C CNN +F 1 "68" V 8507 3801 40 0000 C CNN +F 2 "~" V 8430 3800 30 0000 C CNN +F 3 "~" H 8500 3800 30 0000 C CNN + 1 8500 3800 + 0 -1 -1 0 +$EndComp +$Comp +L classic-v1-rescue:R R2 +U 1 1 53F78FA7 +P 8500 3650 +F 0 "R2" V 8580 3650 40 0000 C CNN +F 1 "1K5" V 8507 3651 40 0000 C CNN +F 2 "~" V 8430 3650 30 0000 C CNN +F 3 "~" H 8500 3650 30 0000 C CNN + 1 8500 3650 + 0 -1 -1 0 +$EndComp +Wire Wire Line + 8750 3650 8750 3800 +Wire Wire Line + 8750 3800 8850 3800 +Wire Wire Line + 8850 3800 8850 3850 +Text GLabel 8100 4250 3 60 Input ~ 0 +PB3 +Wire Wire Line + 8250 3800 8100 3800 +Wire Wire Line + 8100 3800 8100 4250 +Text GLabel 7950 4250 3 60 Input ~ 0 +VCC +Wire Wire Line + 7950 4250 7950 3650 +Wire Wire Line + 7950 3650 8250 3650 +Wire Wire Line + 2800 4000 3000 4000 +Text GLabel 2800 4000 0 60 Input ~ 0 +GND +Connection ~ 3000 4000 +Wire Wire Line + 3250 3600 3250 3700 +Wire Wire Line + 2800 3600 3000 3600 +Text GLabel 2800 3600 0 60 Input ~ 0 +VCC +Connection ~ 3000 3600 +Text GLabel 4800 3700 2 60 Input ~ 0 +PB3 +Text GLabel 4800 3850 2 60 Input ~ 0 +PB4 +Text GLabel 4800 4000 2 60 Input ~ 0 +PB5 +Text GLabel 4800 3350 2 60 Input ~ 0 +PB2 +Text GLabel 4800 3200 2 60 Input ~ 0 +PB1 +Text GLabel 4800 3050 2 60 Input ~ 0 +PB0 +Wire Wire Line + 4800 3050 4700 3050 +Wire Wire Line + 4800 3200 4700 3200 +Wire Wire Line + 4800 3350 4700 3350 +Wire Wire Line + 4800 3700 4700 3700 +Wire Wire Line + 4800 3850 4700 3850 +Wire Wire Line + 4800 4000 4700 4000 +Text GLabel 8900 5350 2 60 Input ~ 0 +PB1 +Text GLabel 8900 5500 2 60 Input ~ 0 +VCC +Text GLabel 8900 5650 2 60 Input ~ 0 +PB2 +Text GLabel 8900 5800 2 60 Input ~ 0 +PB0 +Text GLabel 8900 5950 2 60 Input ~ 0 +PB5 +Text GLabel 8900 6100 2 60 Input ~ 0 +GND +Wire Wire Line + 8900 5350 8800 5350 +Wire Wire Line + 8800 5500 8900 5500 +Wire Wire Line + 8800 5650 8900 5650 +Wire Wire Line + 8800 5800 8900 5800 +Wire Wire Line + 8800 5950 8900 5950 +Wire Wire Line + 8800 6100 8900 6100 +Text GLabel 2700 6800 2 60 Input ~ 0 +GND +Text GLabel 1500 6800 0 60 Input ~ 0 +PB1 +Wire Wire Line + 1500 6800 1600 6800 +Wire Wire Line + 2100 6800 2200 6800 +Wire Wire Line + 2600 6800 2700 6800 +Text GLabel 4750 6850 2 60 Input ~ 0 +GND +Text GLabel 3550 6650 0 60 Input ~ 0 +PB2 +Wire Wire Line + 3550 6650 3650 6650 +Wire Wire Line + 3650 6850 4650 6850 +Connection ~ 3650 6650 +Connection ~ 4650 6850 +Wire Wire Line + 7950 2150 7950 2500 +Wire Wire Line + 7950 2500 8300 2500 +Wire Wire Line + 9200 1850 9450 1850 +Wire Wire Line + 9200 2700 9500 2700 +Wire Wire Line + 7700 1850 7700 2100 +Wire Wire Line + 3000 4000 3250 4000 +Wire Wire Line + 3000 3600 3250 3600 +Wire Wire Line + 3650 6650 4650 6650 +Wire Wire Line + 4650 6850 4750 6850 +$EndSCHEMATC diff --git a/classic/hw/img/classic-v1-bottom.png b/classic/hw/img/classic-v1-bottom.png new file mode 100644 index 0000000..363d02d Binary files /dev/null and b/classic/hw/img/classic-v1-bottom.png differ diff --git a/classic/hw/img/classic-v1-top.png b/classic/hw/img/classic-v1-top.png new file mode 100644 index 0000000..1e417a5 Binary files /dev/null and b/classic/hw/img/classic-v1-top.png differ diff --git a/classic/hw/img/classic-v1.jpg b/classic/hw/img/classic-v1.jpg new file mode 100644 index 0000000..04ac793 Binary files /dev/null and b/classic/hw/img/classic-v1.jpg differ diff --git a/classic/sn/Makefile b/classic/sn/Makefile new file mode 100644 index 0000000..a8710c7 --- /dev/null +++ b/classic/sn/Makefile @@ -0,0 +1,44 @@ +## +## +## + +.PHONY: help all + +help: ## This help. + @awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) + +.DEFAULT_GOAL := all + +bin/: + @mkdir -p bin + +all: ## build linux, darwin & windows +all: linux darwin windows + +linux: bin/ ## build linux binary + @go get github.com/marcinbor85/gohex + @GOOS=linux GOARCH=amd64 \ + go build -installsuffix cgo -ldflags=" -s -w" \ + -o bin/beeon-classic-sn-linux-amd64 \ + sn.go + +darwin: bin/ ## build darwin binary + @go get github.com/marcinbor85/gohex + @GOOS=darwin GOARCH=amd64 \ + go build -installsuffix cgo -ldflags=" -s -w" \ + -o bin/beeon-classic-sn-darwin-amd64 \ + sn.go + +windows: bin/ ## build windows binary + @go get github.com/marcinbor85/gohex + @GOOS=windows GOARCH=amd64 \ + go build -installsuffix cgo -ldflags=" -s -w" \ + -o bin/beeon-classic-sn-windows-amd64.exe \ + sn.go + +mod-tidy: + @go clean --modcache + @GOPROXY=direct GOSUMDB=off go mod tidy + +clean: + @rm -rf bin \ No newline at end of file diff --git a/classic/sn/go.mod b/classic/sn/go.mod new file mode 100644 index 0000000..b17f033 --- /dev/null +++ b/classic/sn/go.mod @@ -0,0 +1,5 @@ +module microjelly.com/beeon/classic/sn + +go 1.13 + +require github.com/marcinbor85/gohex v0.0.0-20200531163658-baab2527a9a2 diff --git a/classic/sn/go.sum b/classic/sn/go.sum new file mode 100644 index 0000000..46764b1 --- /dev/null +++ b/classic/sn/go.sum @@ -0,0 +1,2 @@ +github.com/marcinbor85/gohex v0.0.0-20200531163658-baab2527a9a2 h1:n7R8fUwWZUB2XtyzBNsYNNm9/XgOBj6pvLi7GLMCHtM= +github.com/marcinbor85/gohex v0.0.0-20200531163658-baab2527a9a2/go.mod h1:Pb6XcsXyropB9LNHhnqaknG/vEwYztLkQzVCHv8sQ3M= diff --git a/classic/sn/sn.go b/classic/sn/sn.go new file mode 100644 index 0000000..cbacfe6 --- /dev/null +++ b/classic/sn/sn.go @@ -0,0 +1,177 @@ +package main + +import ( + "bytes" + "flag" + "fmt" + "io" + "math/rand" + "os" + "strings" + "time" + + "github.com/marcinbor85/gohex" +) + +var ( + snLetters = []rune("ABCDEF0123456789") + snStock string = "BEE#-##-#######" +) + +func main() { + + stockSN := snBytes(snStock) + + inhFile := flag.String("inh", "beeon-classic.hex", "input hex file") + insFile := flag.String("ins", "beeon-sn.txt", "input sn(s) file") + mkFile := flag.Bool("mk", false, "make-file : create random sn(s)") + mkPfx := flag.String("mk-p", "#-##", "make-file-prefix : string to add befoer random sn(s)") + mkAmount := flag.Int("mk-a", 1024, "make-file-amount : how many random sn(s) to make") + flag.Parse() + + // make the sn(s) if being asked + if *mkFile { + rand.Seed(time.Now().UnixNano()) + made := 0 + failLimit := 20 + randStrings := make([]string, *mkAmount) + for made < *mkAmount { + newS := strings.ToUpper(randSeq(7)) + if contains(randStrings, newS) { + failLimit-- + if failLimit < 0 { + break + } + continue + } + randStrings[made] = newS + made++ + } + + for _, v := range randStrings { + fmt.Printf("%s-%s\n", *mkPfx, v) + } + os.Exit(0) + } + + // else patch hex and dump to stdout + sFile, err := os.OpenFile(*insFile, os.O_RDWR, 0666) + if err != nil { + panic(err) + } + defer sFile.Close() + line, err := popLine(sFile) + if err != nil { + panic(err) + } + if string(line) == "" { + panic(fmt.Errorf("no sn(s) %v", line)) + } + newSN := snBytes(strings.Trim(string(line), "\n")) + + hFile, err := os.Open(*inhFile) + if err != nil { + panic(err) + } + defer hFile.Close() + + mem := gohex.NewMemory() + err = mem.ParseIntelHex(hFile) + if err != nil { + panic(err) + } + + rawBytes := mem.ToBinary(0x0000, 8192, 0x00) + indexSN := bytes.Index(rawBytes, stockSN) + + // patch in new SN +6 (BxExEx<>) + mem.SetBinary(uint32(indexSN+6), newSN) + + mem.DumpIntelHex(os.Stdout, 16) +} + +func randSeq(n int) string { + b := make([]rune, n) + for i := range b { + b[i] = snLetters[rand.Intn(len(snLetters))] + } + return string(b) +} + +func contains(a []string, x string) bool { + for _, n := range a { + if x == n { + return true + } + } + return false +} + +func snBytes(i string) []byte { + + bytes := make([]byte, len(i)*2) + r := []byte(i) + idx := 0 + for _, rx := range r { + bytes[idx] = rx + idx = idx + 2 + } + return bytes + +} + +func snString(i string) string { + o := "{ \"SN\": [" + r := []rune(i) + c := "" + for _, rx := range r { + o = fmt.Sprintf("%s%s-%d, 0", o, c, rx) + c = ", " + } + return o + " ] }" +} + +func popLine(f *os.File) ([]byte, error) { + fi, err := f.Stat() + if err != nil { + return nil, err + } + buf := bytes.NewBuffer(make([]byte, 0, fi.Size())) + + _, err = f.Seek(0, io.SeekStart) + if err != nil { + return nil, err + } + _, err = io.Copy(buf, f) + if err != nil { + return nil, err + } + + line, err := buf.ReadBytes('\n') + if err != nil && err != io.EOF { + return nil, err + } + + _, err = f.Seek(0, io.SeekStart) + if err != nil { + return nil, err + } + nw, err := io.Copy(f, buf) + if err != nil { + return nil, err + } + err = f.Truncate(nw) + if err != nil { + return nil, err + } + err = f.Sync() + if err != nil { + return nil, err + } + + _, err = f.Seek(0, io.SeekStart) + if err != nil { + return nil, err + } + return line, nil +}