izapple2/cardMouse.go

package izapple2

import (
	"fmt"
)

/*
Mouse card implementation. Does not emulate a real card, only the behaviour. Idea taken
  from aiie (https://hackaday.io/project/19925-aiie-an-embedded-apple-e-emulator/log/188017-entry-23-here-mousie-mousie-mousie)

See:
	https://www.apple.asimov.net/documentation/hardware/io/AppleMouse%20II%20User%27s%20Manual.pdf
	https://mirrors.apple2.org.za/Apple%20II%20Documentation%20Project/Interface%20Cards/Digitizers/Apple%20Mouse%20Interface%20Card/Documentation/Apple%20II%20Mouse%20Technical%20Notes.pdf

	The management of IN# and PR# is copied from cardInOut

*/

// CardMouse represents a SmartPort card
type CardMouse struct {
	cardBase

	lastX, lastY uint16
	lastPressed  bool

	minX, minY, maxX, maxY uint16
	mode                   uint8

	iIn int
	i   int

	trace bool
}

// NewCardMouse creates a new SmartPort card
func NewCardMouse() *CardMouse {
	var c CardMouse
	c.name = "Mouse Card"
	c.trace = true
	c.maxX = 0x3ff
	c.maxY = 0x3ff
	//c.loadRomFromResource("<internal>//Apple Mouse Interface Card ROM - 342-0270-C.bin")
	return &c
}

const (
	mouseXLo    = uint16(0x478)
	mouseYLo    = uint16(0x4f8)
	mouseXHi    = uint16(0x578)
	mouseYHi    = uint16(0x5f8)
	mouseStatus = uint16(0x778)
	mouseMode   = uint16(0x7f8)
)

const (
	mouseModeEnabled          = uint8(1)
	mouseModeIntMoveEnabled   = uint8(2)
	mouseModeIntButtonEnabled = uint8(4)
	mouseModeIntVBlankEnabled = uint8(4)
)

func (c *CardMouse) set(field uint16, value uint8) {
	c.a.mmu.Poke(field+uint16(c.slot), value)
}

func (c *CardMouse) get(field uint16) uint8 {
	return c.a.mmu.Peek(field /*+ uint16(c.slot)*/)
}

func (c *CardMouse) setMode(mode uint8) {
	c.mode = mode
	enabled := mode&mouseModeEnabled == 1
	moveInts := mode&mouseModeIntMoveEnabled == 1
	buttonInts := mode&mouseModeIntButtonEnabled == 1
	vBlankInts := mode&mouseModeIntVBlankEnabled == 1
	if c.trace {
		fmt.Printf("[cardMouse] Mode set to 0x%02x. Enabled %v. Interrups: move=%v, button=%v, vblank=%v.\n",
			mode, enabled, moveInts, buttonInts, vBlankInts)
	}
	if moveInts || buttonInts || vBlankInts {
		panic("Mouse interrupts not implemented")
	}
}

const mouseReponse = "10,10,+4\n"

func (c *CardMouse) assign(a *Apple2, slot int) {
	c.addCardSoftSwitchR(0, func(*ioC0Page) uint8 {
		// TODO
		value := uint8(mouseReponse[c.i])
		c.i = (c.i + 1) % len(mouseReponse)
		value += 0x80
		if value&0x7f == 10 {
			value = 13 + 0x80
		}
		if c.trace {
			fmt.Printf("[cardMouse] Read access to softswith 0x%x for slot %v, value %x.\n", 0, slot, value)
		}
		return value
	}, "MOUSEOUT")

	c.addCardSoftSwitchW(1, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] Write access to softswith 0x%x for slot %v, value 0x%x: %v, %v.\n", 1, slot, value, value&0x7f, string(value&0x7f))
		}
		if c.iIn == 0 {
			// We care only about the first byte
			c.setMode(value & 0x0f)
		}
		c.iIn++
		if value == 13 {
			c.iIn = 0 // Ready for the next command
		}
	}, "MOUSEIN")

	c.addCardSoftSwitchW(2, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] SetMouse(0x%02v)\n", value)
		}
		c.setMode(value & 0x0f)
	}, "SETMOUSE")

	c.addCardSoftSwitchW(3, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] ServeMouse(0x%02v)\n", value)
		}
	}, "SERVEMOUSE")

	c.addCardSoftSwitchW(4, func(_ *ioC0Page, value uint8) {
		if c.mode&mouseModeEnabled == 1 {
			x, y, pressed := a.io.mouse.ReadMouse()

			xTrans := uint16(uint64(c.maxX-c.minX) * uint64(x) / 65536)
			yTrans := uint16(uint64(c.maxY-c.minY) * uint64(y) / 65536)

			status := uint8(0)
			if pressed {
				status |= 1 << 7
			}
			if c.lastPressed {
				status |= 1 << 6
			}
			if (xTrans != c.lastX) || (yTrans != c.lastY) {
				status |= 1 << 5
			}

			c.set(mouseXHi, uint8(xTrans>>8))
			c.set(mouseYHi, uint8(yTrans>>8))
			c.set(mouseXLo, uint8(xTrans))
			c.set(mouseYLo, uint8(yTrans))
			c.set(mouseStatus, status)
			c.set(mouseMode, c.mode)
			if c.trace && ((status&(1<<5) != 0) || (pressed != c.lastPressed)) {
				fmt.Printf("[cardMouse] ReadMouse(): x: %v, y: %v, pressed: %v\n",
					xTrans, yTrans, pressed)
			}

			c.lastX = xTrans
			c.lastY = yTrans
			c.lastPressed = pressed
		}
	}, "READMOUSE")

	c.addCardSoftSwitchW(5, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] ClearMouse()\n")
		}
		c.set(mouseXHi, 0)
		c.set(mouseYHi, 0)
		c.set(mouseXLo, 0)
		c.set(mouseYLo, 0)
	}, "CLEARMOUSE")
	c.addCardSoftSwitchW(6, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] PosMouse(0x%02v)\n", value)
		}
	}, "POSMOUSE")

	c.addCardSoftSwitchW(7, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] ClampMouse(%v)\n", value)
		}

		if value == 0 {
			//c.a.cpu.SetTrace(false)
			c.minX = uint16(c.get(mouseXLo)) + uint16(c.get(mouseXHi))<<8
			c.maxX = uint16(c.get(mouseYLo)) + uint16(c.get(mouseYHi))<<8
		} else if value == 1 {
			//c.a.cpu.SetTrace(true)
			c.minY = uint16(c.get(mouseXLo)) + uint16(c.get(mouseXHi))<<8
			c.maxY = uint16(c.get(mouseYLo)) + uint16(c.get(mouseYHi))<<8
		}

		if c.trace {
			fmt.Printf("[cardMouse] Current bounds: X[%v-%v], Y[%v-%v],\n", c.minX, c.maxX, c.minY, c.maxY)
		}
	}, "CLAMPMOUSE")

	c.addCardSoftSwitchW(8, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] HomeMouse(0x%02x)\n", value)
		}
	}, "HOMEMOUSE")

	c.addCardSoftSwitchW(0xc, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] InitMouse()\n")
		}
		c.minX = 0
		c.minY = 0
		c.maxX = 0x3ff
		c.maxY = 0x3ff
		c.mode = 0
	}, "INITMOUSE")

	c.addCardSoftSwitchW(8, func(_ *ioC0Page, value uint8) {
		if c.trace {
			fmt.Printf("[cardMouse] TimeData(%v)\n", value)
		}
	}, "TIMEDATEMOUSE")

	data := buildBaseInOutRom(slot)
	c.romCsxx = newMemoryRangeROM(0xC200, data[:], "Mouse card")

	// Identification as a mouse card
	// From Technical Note Misc #8, "Pascal 1.1 Firmware Protocol ID Bytes":
	data[0x05] = 0x38
	data[0x07] = 0x18
	data[0x0b] = 0x01
	data[0x0c] = 0x20
	// From "AppleMouse // User's Manual", Appendix B:
	//data[0x0c] = 0x20
	data[0xfb] = 0xd6

	// Set 8 entrypoints to sofstwitches 2 to 1f
	for i := uint8(0); i < 14; i++ {
		base := 0x60 + 0x05*i
		data[0x12+i] = base
		data[base+0] = 0x8D // STA $C0x2
		data[base+1] = 0x82 + i + uint8(slot<<4)
		data[base+2] = 0xC0
		data[base+3] = 0x18 // CLC ;no error
		data[base+4] = 0x60 // RTS
	}

	c.cardBase.assign(a, slot)
}