Skip to content

Commit

Permalink
machine/usb: add support for ISERIAL descriptor
Browse files Browse the repository at this point in the history
  • Loading branch information
sago35 authored and deadprogram committed Nov 6, 2023
1 parent ce25f00 commit 2b21595
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 4 deletions.
8 changes: 6 additions & 2 deletions src/examples/hid-keyboard/main.go
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// to override the USB Manufacturer or Product names:
//
// tinygo flash -target circuitplay-express -ldflags="-X main.usbManufacturer='TinyGopher Labs' -X main.usbProduct='GopherKeyboard'" examples/hid-keyboard
// tinygo flash -target circuitplay-express -ldflags="-X main.usbManufacturer='TinyGopher Labs' -X main.usbProduct='GopherKeyboard' -X main.usbSerial='XXXXX'" examples/hid-keyboard
//
// you can also override the VID/PID. however, only set this if you know what you are doing,
// since changing it can make it difficult to reflash some devices.
Expand All @@ -15,7 +15,7 @@ import (
)

var usbVID, usbPID string
var usbManufacturer, usbProduct string
var usbManufacturer, usbProduct, usbSerial string

func main() {
button := machine.BUTTON
Expand Down Expand Up @@ -49,4 +49,8 @@ func init() {
if usbProduct != "" {
usb.Product = usbProduct
}

if usbSerial != "" {
usb.Serial = usbSerial
}
}
17 changes: 15 additions & 2 deletions src/machine/usb.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@ func usbProduct() string {
return usb_STRING_PRODUCT
}

func usbSerial() string {
if usb.Serial != "" {
return usb.Serial
}
return ""
}

// strToUTF16LEDescriptor converts a utf8 string into a string descriptor
// note: the following code only converts ascii characters to UTF16LE. In order
// to do a "proper" conversion, we would need to pull in the 'unicode/utf16'
Expand Down Expand Up @@ -160,8 +167,14 @@ func sendDescriptor(setup usb.Setup) {
sendUSBPacket(0, b, setup.WLength)

case usb.ISERIAL:
// TODO: allow returning a product serial number
SendZlp()
sz := len(usbSerial())
if sz == 0 {
SendZlp()
} else {
b := usb_trans_buffer[:(sz<<1)+2]
strToUTF16LEDescriptor(usbSerial(), b)
sendUSBPacket(0, b, setup.WLength)
}
}
return
case descriptor.TypeHIDReport:
Expand Down
4 changes: 4 additions & 0 deletions src/machine/usb/usb.go
Original file line number Diff line number Diff line change
Expand Up @@ -134,4 +134,8 @@ var (

// Product is the product name displayed for this USB device.
Product string

// Serial is the serial value displayed for this USB device. Assign a value to
// transmit the serial to the host when requested.
Serial string
)

0 comments on commit 2b21595

Please sign in to comment.