machine/usb/hid/joystick: move joystick under HID as it belongs and also remove duplicate code

Signed-off-by: deadprogram <ron@hybridgroup.com>
2026-08-06 12:03:41 +00:00 · 2023-03-31 15:40:40 +02:00
parent 7d83e76833
commit 9e97566b5f
6 changed files with 80 additions and 150 deletions
@@ -50,6 +50,8 @@ func handler() {
 	}
 }

+var DefaultSetupHandler = setupHandler
+
 func setupHandler(setup usb.Setup) bool {
 	ok := false
 	if setup.BmRequestType == usb.SET_REPORT_TYPE && setup.BRequest == usb.SET_IDLE {
@@ -0,0 +1,77 @@
+package joystick
+
+import (
+	"machine"
+	"machine/usb"
+	"machine/usb/hid"
+)
+
+var Joystick *joystick
+
+type joystick struct {
+	State
+	buf           *hid.RingBuffer
+	waitTxc       bool
+	rxHandlerFunc func(b []byte)
+	setupFunc     func(setup usb.Setup) bool
+}
+
+func init() {
+	if Joystick == nil {
+		Joystick = newJoystick()
+	}
+}
+
+func newJoystick() *joystick {
+	def := DefaultDefinitions()
+	js := &joystick{
+		State: def.NewState(),
+		buf:   hid.NewRingBuffer(),
+	}
+	machine.EnableJoystick(js.handler, js.rxHandler, hid.DefaultSetupHandler, def.Descriptor())
+	return js
+}
+
+// Port returns the USB Joystick port.
+func Port() *joystick {
+	return Joystick
+}
+
+func (m *joystick) handler() {
+	m.waitTxc = false
+	if b, ok := m.buf.Get(); ok {
+		m.waitTxc = true
+		hid.SendUSBPacket(b)
+	}
+}
+
+func (m *joystick) tx(b []byte) {
+	if machine.USBDev.InitEndpointComplete {
+		if m.waitTxc {
+			m.buf.Put(b)
+		} else {
+			m.waitTxc = true
+			hid.SendUSBPacket(b)
+		}
+	}
+}
+
+func (m *joystick) ready() bool {
+	return true
+}
+
+func (m *joystick) rxHandler(b []byte) {
+	if m.rxHandlerFunc != nil {
+		m.rxHandlerFunc(b)
+	}
+}
+
+// to InterruptOut
+func (m *joystick) SendReport(reportID byte, b []byte) {
+	m.tx(append([]byte{reportID}, b...))
+}
+
+func (m *joystick) SendState() {
+	b, _ := m.State.MarshalBinary()
+	m.tx(b)
+}
@@ -0,0 +1,213 @@
+package joystick
+
+import "encoding/binary"
+
+type HatDirection uint8
+
+const (
+	HatUp HatDirection = iota
+	HatRightUp
+	HatRight
+	HatRightDown
+	HatDown
+	HatLeftDown
+	HatLeft
+	HatLeftUp
+	HatCenter
+)
+
+type Constraint struct {
+	MinIn  int
+	MaxIn  int
+	MinOut int16
+	MaxOut int16
+}
+
+type AxisValue struct {
+	constraint Constraint
+	Value      int
+}
+
+func fit(x, in_min, in_max int, out_min, out_max int16) int16 {
+	return int16((x-in_min)*(int(out_max)-int(out_min))/(in_max-in_min) + int(out_min))
+}
+
+func fitf(x, in_min, in_max, out_min, out_max float32) float32 {
+	return x - in_min*(out_max-out_min)/(in_max-in_min) + out_min
+}
+
+func limit(v, max int) int {
+	if v > max {
+		v = max
+	} else if v < -max {
+		v = -max
+	}
+	return v
+}
+
+type Definitions struct {
+	ReportID     byte
+	ButtonCnt    int
+	HatSwitchCnt int
+	AxisDefs     []Constraint
+	descriptor   []byte
+}
+
+func (c Definitions) Descriptor() []byte {
+	if len(c.descriptor) > 0 {
+		return c.descriptor
+	}
+	// TODO: build hid descriptor
+	return nil
+}
+
+func (c Definitions) NewState() State {
+	bufSize := 1
+	axises := make([]*AxisValue, 0, len(c.AxisDefs))
+	for _, v := range c.AxisDefs {
+
+		axises = append(axises, &AxisValue{
+			constraint: v,
+			Value:      0,
+		})
+	}
+	btnSize := (c.ButtonCnt + 7) / 8
+	bufSize += btnSize
+	if c.HatSwitchCnt > 0 {
+		bufSize++
+	}
+	bufSize += len(axises) * 2
+	initBuf := make([]byte, bufSize)
+	initBuf[0] = c.ReportID
+	return State{
+		buf:         initBuf,
+		Buttons:     make([]byte, btnSize),
+		HatSwitches: make([]HatDirection, c.HatSwitchCnt),
+		Axises:      axises,
+	}
+}
+
+type State struct {
+	buf         []byte
+	Buttons     []byte
+	HatSwitches []HatDirection
+	Axises      []*AxisValue
+}
+
+func (s State) MarshalBinary() ([]byte, error) {
+	s.buf = s.buf[0:1]
+	s.buf = append(s.buf, s.Buttons...)
+	if len(s.HatSwitches) > 0 {
+		hat := byte(0)
+		for _, v := range s.HatSwitches {
+			hat <<= 4
+			hat |= byte(v & 0xf)
+		}
+		s.buf = append(s.buf, hat)
+	}
+	for _, v := range s.Axises {
+		c := v.constraint
+		val := fit(v.Value, c.MinIn, c.MaxIn, c.MinOut, c.MaxOut)
+		s.buf = binary.LittleEndian.AppendUint16(s.buf, uint16(val))
+	}
+	return s.buf, nil
+}
+
+func (s State) Button(index int) bool {
+	idx := index / 8
+	bit := uint8(1 << (index % 8))
+	return s.Buttons[idx]&bit > 0
+}
+
+func (s State) SetButton(index int, push bool) {
+	idx := index / 8
+	bit := uint8(1 << (index % 8))
+	b := s.Buttons[idx]
+	b &= ^bit
+	if push {
+		b |= bit
+	}
+	s.Buttons[idx] = b
+}
+
+func (s State) Hat(index int) HatDirection {
+	return s.HatSwitches[index]
+}
+
+func (s State) SetHat(index int, dir HatDirection) {
+	s.HatSwitches[index] = dir
+}
+
+func (s State) Axis(index int) int {
+	return s.Axises[index].Value
+}
+
+func (s State) SetAxis(index int, v int) {
+	s.Axises[index].Value = v
+}
+
+func DefaultDefinitions() Definitions {
+	return Definitions{
+		ReportID:     1,
+		ButtonCnt:    16,
+		HatSwitchCnt: 1,
+		AxisDefs: []Constraint{
+			{MinIn: -32767, MaxIn: 32767, MinOut: -32767, MaxOut: 32767},
+			{MinIn: -32767, MaxIn: 32767, MinOut: -32767, MaxOut: 32767},
+			{MinIn: -32767, MaxIn: 32767, MinOut: -32767, MaxOut: 32767},
+			{MinIn: -32767, MaxIn: 32767, MinOut: -32767, MaxOut: 32767},
+			{MinIn: -32767, MaxIn: 32767, MinOut: -32767, MaxOut: 32767},
+			{MinIn: -32767, MaxIn: 32767, MinOut: -32767, MaxOut: 32767},
+		},
+		descriptor: []byte{
+			0x05, 0x01,
+			0x09, 0x04,
+			0xa1, 0x01, // COLLECTION (Application)
+			0x85, 0x01, // REPORT_ID (1)
+			0x05, 0x09, // USAGE_PAGE (Button)
+			0x19, 0x01, // USAGE_MINIMUM (Button 1)
+			0x29, 0x10, // USAGE_MAXIMUM (Button 16)
+			0x15, 0x00, // LOGICAL_MINIMUM (0)
+			0x25, 0x01, // LOGICAL_MAXIMUM (1)
+			0x75, 0x01, // REPORT_SIZE (1)
+			0x95, 0x10, // REPORT_COUNT (16)
+			0x55, 0x00, // Unit Exponent (-16)
+			0x65, 0x00, // Unit (0x00)
+			0x81, 0x02, // INPUT (Data/Var/Abs)
+			0x05, 0x01, // USAGE_PAGE (Generic Desktop Controls)
+			0x09, 0x39, // USAGE(Hat Switch)
+			0x15, 0x00, // LOGICAL_MINIMUM (0)
+			0x25, 0x07, // LOGICAL_MAXIMUM (7)
+			0x35, 0x00, // PHYSICAL_MINIMUM (0)
+			0x46, 0x3b, 0x01, // PHYSICAL_MAXIMUM(315)
+			0x65, 0x14, // UNIT (Eng Rot:Angular Pos)
+			0x75, 0x04, // REPORT_SIZE (4)
+			0x95, 0x01, // REPORT_COUNT (1)
+			0x81, 0x02, // INPUT (Data/Var/Abs)
+			0x09, 0x39, // USAGE(Hat Switch)
+			0x15, 0x00, // LOGICAL_MINIMUM (0)
+			0x25, 0x07, // LOGICAL_MAXIMUM (7)
+			0x35, 0x00, // PHYSICAL_MINIMUM (0)
+			0x46, 0x3b, 0x01, // PHYSICAL_MAXIMUM(315)
+			0x65, 0x14, // UNIT (Eng Rot:Angular Pos)
+			0x75, 0x04, // REPORT_SIZE (4)
+			0x95, 0x01, // REPORT_COUNT (1)
+			0x81, 0x02, // INPUT (Data/Var/Abs)
+			0x09, 0x01, // USAGE (Pointer)
+			0x16, 0x01, 0x80, // LOGICAL_MINIMUM (-32767)
+			0x26, 0xff, 0x7f, // LOGICAL_MAXIMUM (32767)
+			0x75, 0x10, // REPORT_SIZE (16bits)
+			0x95, 0x06, // REPORT_COUNT (6)
+			0xa1, 0x00, // COLLECTION (Physical)
+			0x09, 0x30, // USAGE(X)
+			0x09, 0x31, // USAGE(Y)
+			0x09, 0x32, // USAGE(Z)
+			0x09, 0x33, // USAGE(RX)
+			0x09, 0x34, // USAGE(RY)
+			0x09, 0x35, // USAGE(RZ)
+			0x81, 0x02, // INPUT (Data/Var/Abs)
+			0xc0, // END_COLLECTION
+			0xc0, // END_COLLECTION
+		},
+	}
+}