feature: modify i2s interface/implementation to better match specification

deadprogram · deadprogram · commit 5701bf81f30d · 2024-12-18T15:23:00.000+01:00
Signed-off-by: deadprogram &lt;ron@hybridgroup.com&gt;
diff --git a/src/examples/i2s/i2s.go b/src/examples/i2s/i2s.go
@@ -13,11 +13,11 @@ func main() {
 		Stereo:      true,
 	})
 
-	data := make([]uint32, 64)
+	data := make([]uint16, 64)
 
 	for {
 		// get the next group of samples
-		machine.I2S0.Read(data)
+		machine.I2S0.ReadMono(data)
 
 		println("data", data[0], data[1], data[2], data[4], "...")
 	}
diff --git a/src/machine/board_arduino_mkr1000.go b/src/machine/board_arduino_mkr1000.go
@@ -74,8 +74,9 @@ const (
 // I2S pins
 const (
 	I2S_SCK_PIN Pin = PA10
-	I2S_SD_PIN  Pin = PA07
-	I2S_WS_PIN      = NoPin // TODO: figure out what this is on Arduino Nano 33.
+	I2S_SDO_PIN Pin = PA07
+	I2S_SDI_PIN     = NoPin
+	I2S_WS_PIN      = NoPin // TODO: figure out what this is on Arduino MKR1000
 )
 
 // USB CDC identifiers
diff --git a/src/machine/board_arduino_mkrwifi1010.go b/src/machine/board_arduino_mkrwifi1010.go
@@ -74,7 +74,8 @@ const (
 // I2S pins
 const (
 	I2S_SCK_PIN Pin = PA10
-	I2S_SD_PIN  Pin = PA07
+	I2S_SDO_PIN Pin = PA07
+	I2S_SDI_PIN     = NoPin
 	I2S_WS_PIN      = NoPin // TODO: figure out what this is on Arduino MKR WiFi 1010.
 )
 
diff --git a/src/machine/board_arduino_nano33.go b/src/machine/board_arduino_nano33.go
@@ -118,7 +118,8 @@ const (
 // I2S pins
 const (
 	I2S_SCK_PIN Pin = PA10
-	I2S_SD_PIN  Pin = PA08
+	I2S_SDO_PIN Pin = PA08
+	I2S_SDI_PIN     = NoPin
 	I2S_WS_PIN      = NoPin // TODO: figure out what this is on Arduino Nano 33.
 )
 
diff --git a/src/machine/board_arduino_zero.go b/src/machine/board_arduino_zero.go
@@ -69,7 +69,8 @@ const (
 // I2S pins - might not be exposed
 const (
 	I2S_SCK_PIN Pin = PA10
-	I2S_SD_PIN  Pin = PA07
+	I2S_SDO_PIN Pin = PA07
+	I2S_SDI_PIN     = NoPin
 	I2S_WS_PIN  Pin = PA11
 )
 
diff --git a/src/machine/board_circuitplay_express.go b/src/machine/board_circuitplay_express.go
@@ -102,7 +102,8 @@ var SPI0 = sercomSPIM3
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA08
+	I2S_SDO_PIN = PA08
+	I2S_SDI_PIN = NoPin
 	I2S_WS_PIN  = NoPin // no WS, instead uses SCK to sync
 )
 
diff --git a/src/machine/board_feather-m0-express.go b/src/machine/board_feather-m0-express.go
@@ -81,7 +81,8 @@ var SPI0 = sercomSPIM4
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA07
+	I2S_SDO_PIN = PA07
+	I2S_SDI_PIN = NoPin
 	I2S_WS_PIN  = NoPin // TODO: figure out what this is on Feather M0 Express.
 )
 
diff --git a/src/machine/board_feather-m0.go b/src/machine/board_feather-m0.go
@@ -76,7 +76,8 @@ var SPI0 = sercomSPIM4
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA08
+	I2S_SDO_PIN = PA08
+	I2S_SDI_PIN = NoPin
 	I2S_WS_PIN  = NoPin // TODO: figure out what this is on Feather M0.
 )
 
diff --git a/src/machine/board_gemma-m0.go b/src/machine/board_gemma-m0.go
@@ -76,7 +76,8 @@ var (
 // I2S (not connected, needed for atsamd21).
 const (
 	I2S_SCK_PIN = NoPin
-	I2S_SD_PIN  = NoPin
+	I2S_SDO_PIN = NoPin
+	I2S_SDI_PIN = NoPin
 	I2S_WS_PIN  = NoPin
 )
 
diff --git a/src/machine/board_grandcentral-m4.go b/src/machine/board_grandcentral-m4.go
@@ -224,7 +224,8 @@ const (
 
 	I2S_SCK_PIN = I2S0_SCK_PIN // default pins
 	I2S_WS_PIN  = I2S0_FS_PIN  //
-	I2S_SD_PIN  = I2S0_SDO_PIN //
+	I2S_SDO_PIN = I2S0_SDO_PIN
+	I2S_SDI_PIN = NoPin
 )
 
 // SD card pins
diff --git a/src/machine/board_itsybitsy-m0.go b/src/machine/board_itsybitsy-m0.go
@@ -89,7 +89,8 @@ var SPI1 = sercomSPIM5
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA08
+	I2S_SDO_PIN = PA08
+	I2S_SDI_PIN = NoPin
 	I2S_WS_PIN  = NoPin // TODO: figure out what this is on ItsyBitsy M0.
 )
 
diff --git a/src/machine/board_p1am-100.go b/src/machine/board_p1am-100.go
@@ -123,7 +123,8 @@ var (
 // I2S pins
 const (
 	I2S_SCK_PIN Pin = D2
-	I2S_SD_PIN  Pin = A6
+	I2S_SDO_PIN Pin = A6
+	I2S_SDI_PIN     = NoPin
 	I2S_WS_PIN      = D3
 )
 
diff --git a/src/machine/board_qtpy.go b/src/machine/board_qtpy.go
@@ -81,7 +81,8 @@ var (
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA08
+	I2S_SDO_PIN = PA08
+	I2S_SDI_PIN = NoPin // TODO: figure out what this is on QT Py M0.
 	I2S_WS_PIN  = NoPin // TODO: figure out what this is on QT Py M0.
 )
 
diff --git a/src/machine/board_trinket.go b/src/machine/board_trinket.go
@@ -67,7 +67,8 @@ var (
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA08
+	I2S_SDO_PIN = PA08
+	I2S_SDI_PIN = NoPin // TODO: figure out what this is on Trinket M0.
 	I2S_WS_PIN  = NoPin // TODO: figure out what this is on Trinket M0.
 )
 
diff --git a/src/machine/board_wioterminal.go b/src/machine/board_wioterminal.go
@@ -376,6 +376,14 @@ var (
 	I2C1 = sercomI2CM3
 )
 
+// I2S pins
+const (
+	I2S_SCK_PIN = BCM18
+	I2S_SDO_PIN = BCM21
+	I2S_SDI_PIN = BCM20
+	I2S_WS_PIN  = BCM19
+)
+
 // SPI pins
 const (
 	SPI0_SCK_PIN = SCK // SCK:  SERCOM5/PAD[1]
diff --git a/src/machine/board_xiao.go b/src/machine/board_xiao.go
@@ -82,7 +82,8 @@ var SPI0 = sercomSPIM0
 // I2S pins
 const (
 	I2S_SCK_PIN = PA10
-	I2S_SD_PIN  = PA08
+	I2S_SDO_PIN = PA08
+	I2S_SDI_PIN = NoPin // TODO: figure out what this is on Xiao
 	I2S_WS_PIN  = NoPin // TODO: figure out what this is on Xiao
 )
 
diff --git a/src/machine/i2s.go b/src/machine/i2s.go
@@ -1,4 +1,4 @@
-//go:build sam
+//go:build sam && atsamd21
 
 // This is the definition for I2S bus functions.
 // Actual implementations if available for any given hardware
@@ -9,6 +9,22 @@
 
 package machine
 
+import "errors"
+
+// If you are getting a compile error on this line please check to see you've
+// correctly implemented the methods on the I2S type. They must match
+// the interface method signatures type to type perfectly.
+// If not implementing the I2S type please remove your target from the build tags
+// at the top of this file.
+var _ interface {
+	SetSampleFrequency(freq uint32) error
+	ReadMono(b []uint16) (int, error)
+	ReadStereo(b []uint32) (int, error)
+	WriteMono(b []uint16) (int, error)
+	WriteStereo(b []uint32) (int, error)
+	Enable(enabled bool)
+} = (*I2S)(nil)
+
 type I2SMode uint8
 type I2SStandard uint8
 type I2SClockSource uint8
@@ -18,6 +34,7 @@ const (
 	I2SModeSource I2SMode = iota
 	I2SModeReceiver
 	I2SModePDM
+	I2SModeSourceReceiver
 )
 
 const (
@@ -39,11 +56,20 @@ const (
 	I2SDataFormat32bit                 = 32
 )
 
+var (
+	ErrInvalidSampleFrequency = errors.New("i2s: invalid sample frequency")
+)
+
 // All fields are optional and may not be required or used on a particular platform.
 type I2SConfig struct {
-	SCK             Pin
-	WS              Pin
-	SD              Pin
+	// clock
+	SCK Pin
+	// word select
+	WS Pin
+	// data out
+	SDO Pin
+	// data in
+	SDI             Pin
 	Mode            I2SMode
 	Standard        I2SStandard
 	ClockSource     I2SClockSource
diff --git a/src/machine/machine_atsamd21.go b/src/machine/machine_atsamd21.go

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,8 @@ const (`
`74`	`74`	`// I2S pins`
`75`	`75`	`const (`
`76`	`76`	`I2S_SCK_PIN Pin = PA10`
`77`		`- I2S_SD_PIN Pin = PA07`
	`77`	`+ I2S_SDO_PIN Pin = PA07`
	`78`	`+ I2S_SDI_PIN = NoPin`
`78`	`79`	`I2S_WS_PIN = NoPin // TODO: figure out what this is on Arduino MKR WiFi 1010.`
`79`	`80`	`)`
`80`	`81`
Original file line number	Diff line number	Diff line change
`@@ -118,7 +118,8 @@ const (`
`118`	`118`	`// I2S pins`
`119`	`119`	`const (`
`120`	`120`	`I2S_SCK_PIN Pin = PA10`
`121`		`- I2S_SD_PIN Pin = PA08`
	`121`	`+ I2S_SDO_PIN Pin = PA08`
	`122`	`+ I2S_SDI_PIN = NoPin`
`122`	`123`	`I2S_WS_PIN = NoPin // TODO: figure out what this is on Arduino Nano 33.`
`123`	`124`	`)`
`124`	`125`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,8 @@ const (`
`69`	`69`	`// I2S pins - might not be exposed`
`70`	`70`	`const (`
`71`	`71`	`I2S_SCK_PIN Pin = PA10`
`72`		`- I2S_SD_PIN Pin = PA07`
	`72`	`+ I2S_SDO_PIN Pin = PA07`
	`73`	`+ I2S_SDI_PIN = NoPin`
`73`	`74`	`I2S_WS_PIN Pin = PA11`
`74`	`75`	`)`
`75`	`76`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,8 @@ var SPI0 = sercomSPIM3`
`102`	`102`	`// I2S pins`
`103`	`103`	`const (`
`104`	`104`	`I2S_SCK_PIN = PA10`
`105`		`- I2S_SD_PIN = PA08`
	`105`	`+ I2S_SDO_PIN = PA08`
	`106`	`+ I2S_SDI_PIN = NoPin`
`106`	`107`	`I2S_WS_PIN = NoPin // no WS, instead uses SCK to sync`
`107`	`108`	`)`
`108`	`109`
Original file line number	Diff line number	Diff line change
`@@ -81,7 +81,8 @@ var SPI0 = sercomSPIM4`
`81`	`81`	`// I2S pins`
`82`	`82`	`const (`
`83`	`83`	`I2S_SCK_PIN = PA10`
`84`		`- I2S_SD_PIN = PA07`
	`84`	`+ I2S_SDO_PIN = PA07`
	`85`	`+ I2S_SDI_PIN = NoPin`
`85`	`86`	`I2S_WS_PIN = NoPin // TODO: figure out what this is on Feather M0 Express.`
`86`	`87`	`)`
`87`	`88`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,8 @@ var SPI0 = sercomSPIM4`
`76`	`76`	`// I2S pins`
`77`	`77`	`const (`
`78`	`78`	`I2S_SCK_PIN = PA10`
`79`		`- I2S_SD_PIN = PA08`
	`79`	`+ I2S_SDO_PIN = PA08`
	`80`	`+ I2S_SDI_PIN = NoPin`
`80`	`81`	`I2S_WS_PIN = NoPin // TODO: figure out what this is on Feather M0.`
`81`	`82`	`)`
`82`	`83`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,8 @@ var (`
`76`	`76`	`// I2S (not connected, needed for atsamd21).`
`77`	`77`	`const (`
`78`	`78`	`I2S_SCK_PIN = NoPin`
`79`		`- I2S_SD_PIN = NoPin`
	`79`	`+ I2S_SDO_PIN = NoPin`
	`80`	`+ I2S_SDI_PIN = NoPin`
`80`	`81`	`I2S_WS_PIN = NoPin`
`81`	`82`	`)`
`82`	`83`
Original file line number	Diff line number	Diff line change
`@@ -224,7 +224,8 @@ const (`
`224`	`224`
`225`	`225`	`I2S_SCK_PIN = I2S0_SCK_PIN // default pins`
`226`	`226`	`I2S_WS_PIN = I2S0_FS_PIN //`
`227`		`- I2S_SD_PIN = I2S0_SDO_PIN //`
	`227`	`+ I2S_SDO_PIN = I2S0_SDO_PIN`
	`228`	`+ I2S_SDI_PIN = NoPin`
`228`	`229`	`)`
`229`	`230`
`230`	`231`	`// SD card pins`