machine: move PinMode to central location

aykevl · deadprogram · commit 2f1f8fb07550 · 2021-05-06T13:59:12.000+02:00
It is always implemented exactly the same way (as an uint8) so there is
no reason to implement it in each target separately.

This also makes it easier to add some documentation to it.
diff --git a/src/machine/machine.go b/src/machine/machine.go
@@ -10,6 +10,11 @@ var (
 	ErrNoPinChangeChannel = errors.New("machine: no channel available for pin interrupt")
 )
 
+// PinMode sets the direction and pull mode of the pin. For example, PinOutput
+// sets the pin as an output and PinInputPullup sets the pin as an input with a
+// pull-up.
+type PinMode uint8
+
 type PinConfig struct {
 	Mode PinMode
 }
diff --git a/src/machine/machine_atsamd21.go b/src/machine/machine_atsamd21.go
@@ -16,8 +16,6 @@ import (
 	"unsafe"
 )
 
-type PinMode uint8
-
 const (
 	PinAnalog    PinMode = 1
 	PinSERCOM    PinMode = 2
diff --git a/src/machine/machine_atsamd51.go b/src/machine/machine_atsamd51.go
@@ -20,8 +20,6 @@ func CPUFrequency() uint32 {
 	return 120000000
 }
 
-type PinMode uint8
-
 const (
 	PinAnalog        PinMode = 1
 	PinSERCOM        PinMode = 2
diff --git a/src/machine/machine_avr.go b/src/machine/machine_avr.go
@@ -8,8 +8,6 @@ import (
 	"unsafe"
 )
 
-type PinMode uint8
-
 const (
 	PinInput PinMode = iota
 	PinInputPullup
diff --git a/src/machine/machine_esp32.go b/src/machine/machine_esp32.go
@@ -21,8 +21,6 @@ var (
 	ErrInvalidSPIBus = errors.New("machine: invalid SPI bus")
 )
 
-type PinMode uint8
-
 const (
 	PinOutput PinMode = iota
 	PinInput
diff --git a/src/machine/machine_esp8266.go b/src/machine/machine_esp8266.go
@@ -11,8 +11,6 @@ func CPUFrequency() uint32 {
 	return 80000000 // 80MHz
 }
 
-type PinMode uint8
-
 const (
 	PinOutput PinMode = iota
 	PinInput
diff --git a/src/machine/machine_fe310.go b/src/machine/machine_fe310.go
@@ -12,8 +12,6 @@ func CPUFrequency() uint32 {
 	return 16000000
 }
 
-type PinMode uint8
-
 const (
 	PinInput PinMode = iota
 	PinOutput
diff --git a/src/machine/machine_gameboyadvance.go b/src/machine/machine_gameboyadvance.go
@@ -30,8 +30,6 @@ const (
 // Make it easier to directly write to I/O RAM.
 var ioram = (*[0x400]volatile.Register8)(unsafe.Pointer(uintptr(0x04000000)))
 
-type PinMode uint8
-
 // Set has not been implemented.
 func (p Pin) Set(value bool) {
 	// do nothing
diff --git a/src/machine/machine_generic.go b/src/machine/machine_generic.go
@@ -10,8 +10,6 @@ var (
 	UART0 = UART{0}
 )
 
-type PinMode uint8
-
 const (
 	PinInput PinMode = iota
 	PinOutput
diff --git a/src/machine/machine_k210.go b/src/machine/machine_k210.go
@@ -14,7 +14,6 @@ func CPUFrequency() uint32 {
 	return 390000000
 }
 
-type PinMode uint8
 type fpioaPullMode uint8
 type PinChange uint8
 
diff --git a/src/machine/machine_mimxrt1062.go b/src/machine/machine_mimxrt1062.go
@@ -15,8 +15,6 @@ func CPUFrequency() uint32 {
 	return 600000000
 }
 
-type PinMode uint8
-
 const (
 	// GPIO
 	PinInput PinMode = iota
diff --git a/src/machine/machine_nrf.go b/src/machine/machine_nrf.go
@@ -13,8 +13,6 @@ var (
 	ErrTxInvalidSliceSize = errors.New("SPI write and read slices must be same size")
 )
 
-type PinMode uint8
-
 const (
 	PinInput         PinMode = (nrf.GPIO_PIN_CNF_DIR_Input << nrf.GPIO_PIN_CNF_DIR_Pos) | (nrf.GPIO_PIN_CNF_INPUT_Connect << nrf.GPIO_PIN_CNF_INPUT_Pos)
 	PinInputPullup   PinMode = PinInput | (nrf.GPIO_PIN_CNF_PULL_Pullup << nrf.GPIO_PIN_CNF_PULL_Pos)
diff --git a/src/machine/machine_nxpmk66f18.go b/src/machine/machine_nxpmk66f18.go
@@ -37,8 +37,6 @@ import (
 	"unsafe"
 )
 
-type PinMode uint8
-
 const (
 	PinInput PinMode = iota
 	PinInputPullUp
diff --git a/src/machine/machine_stm32.go b/src/machine/machine_stm32.go
@@ -17,8 +17,6 @@ const (
 	portJ
 )
 
-type PinMode uint8
-
 // Peripheral operations sequence:
 //  1. Enable the clock to the alternate function.
 //  2. Enable clock to corresponding GPIO

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,11 @@ var (`
`10`	`10`	`ErrNoPinChangeChannel = errors.New("machine: no channel available for pin interrupt")`
`11`	`11`	`)`
`12`	`12`
	`13`	`+// PinMode sets the direction and pull mode of the pin. For example, PinOutput`
	`14`	`+// sets the pin as an output and PinInputPullup sets the pin as an input with a`
	`15`	`+// pull-up.`
	`16`	`+type PinMode uint8`
	`17`	`+`
`13`	`18`	`type PinConfig struct {`
`14`	`19`	`Mode PinMode`
`15`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,6 @@ import (`
`16`	`16`	`"unsafe"`
`17`	`17`	`)`
`18`	`18`
`19`		`-type PinMode uint8`
`20`		`-`
`21`	`19`	`const (`
`22`	`20`	`PinAnalog PinMode = 1`
`23`	`21`	`PinSERCOM PinMode = 2`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,6 @@ func CPUFrequency() uint32 {`
`20`	`20`	`return 120000000`
`21`	`21`	`}`
`22`	`22`
`23`		`-type PinMode uint8`
`24`		`-`
`25`	`23`	`const (`
`26`	`24`	`PinAnalog PinMode = 1`
`27`	`25`	`PinSERCOM PinMode = 2`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,6 @@ import (`
`8`	`8`	`"unsafe"`
`9`	`9`	`)`
`10`	`10`
`11`		`-type PinMode uint8`
`12`		`-`
`13`	`11`	`const (`
`14`	`12`	`PinInput PinMode = iota`
`15`	`13`	`PinInputPullup`
Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,6 @@ var (`
`21`	`21`	`ErrInvalidSPIBus = errors.New("machine: invalid SPI bus")`
`22`	`22`	`)`
`23`	`23`
`24`		`-type PinMode uint8`
`25`		`-`
`26`	`24`	`const (`
`27`	`25`	`PinOutput PinMode = iota`
`28`	`26`	`PinInput`
Original file line number	Diff line number	Diff line change
`@@ -11,8 +11,6 @@ func CPUFrequency() uint32 {`
`11`	`11`	`return 80000000 // 80MHz`
`12`	`12`	`}`
`13`	`13`
`14`		`-type PinMode uint8`
`15`		`-`
`16`	`14`	`const (`
`17`	`15`	`PinOutput PinMode = iota`
`18`	`16`	`PinInput`
Original file line number	Diff line number	Diff line change
`@@ -12,8 +12,6 @@ func CPUFrequency() uint32 {`
`12`	`12`	`return 16000000`
`13`	`13`	`}`
`14`	`14`
`15`		`-type PinMode uint8`
`16`		`-`
`17`	`15`	`const (`
`18`	`16`	`PinInput PinMode = iota`
`19`	`17`	`PinOutput`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,6 @@ var (`
`10`	`10`	`UART0 = UART{0}`
`11`	`11`	`)`
`12`	`12`
`13`		`-type PinMode uint8`
`14`		`-`
`15`	`13`	`const (`
`16`	`14`	`PinInput PinMode = iota`
`17`	`15`	`PinOutput`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,6 @@ func CPUFrequency() uint32 {`
`14`	`14`	`return 390000000`
`15`	`15`	`}`
`16`	`16`
`17`		`-type PinMode uint8`
`18`	`17`	`type fpioaPullMode uint8`
`19`	`18`	`type PinChange uint8`
`20`	`19`