rename StateMachine.Claim()->TryClaim()

Author: soypat

rp2-pio/pio.go

@@ -71,7 +71,7 @@ func (pio *PIO) StateMachine(index uint8) StateMachine {
 func (pio *PIO) ClaimStateMachine() (sm StateMachine, err error) {
 	for i := uint8(0); i < 4; i++ {
 		sm = pio.StateMachine(i)
-		if sm.Claim() {
+		if sm.TryClaim() {
 			return sm, nil
 		}
 	}

rp2-pio/piolib/i2s.go

@@ -15,7 +15,7 @@ type I2S struct {
 }
 
 func NewI2S(sm pio.StateMachine, data, clockAndNext machine.Pin) (*I2S, error) {
-	sm.Claim() // SM should be claimed beforehand, we just guarantee it's claimed.
+	sm.TryClaim() // SM should be claimed beforehand, we just guarantee it's claimed.
 	Pio := sm.PIO()
 
 	offset, err := Pio.AddProgram(i2sInstructions, i2sOrigin)

rp2-pio/piolib/parallel8.go

@@ -21,7 +21,7 @@ type Parallel8Tx struct {
 const noDMA uint32 = 0xffff_ffff
 
 func NewParallel8Tx(sm pio.StateMachine, wr, dStart machine.Pin, baud uint32) (*Parallel8Tx, error) {
-	sm.Claim() // SM should be claimed beforehand, we just guarantee it's claimed.
+	sm.TryClaim() // SM should be claimed beforehand, we just guarantee it's claimed.
 	const nPins = 8
 	if dStart+nPins > 31 {
 		return nil, errors.New("invalid D0..D7 pin range")

rp2-pio/piolib/pulsar.go

@@ -20,7 +20,7 @@ type Pulsar struct {
 
 // NewPulsar returns a new Pulsar ready for use.
 func NewPulsar(sm pio.StateMachine, pin machine.Pin) (*Pulsar, error) {
-	sm.Claim() // SM should be claimed beforehand, we just guarantee it's claimed.
+	sm.TryClaim() // SM should be claimed beforehand, we just guarantee it's claimed.
 	Pio := sm.PIO()
 
 	offset, err := Pio.AddProgram(pulsarInstructions, pulsarOrigin)

rp2-pio/piolib/spi.go

@@ -16,7 +16,7 @@ type SPI struct {
 }
 
 func NewSPI(sm pio.StateMachine, spicfg machine.SPIConfig) (*SPI, error) {
-	sm.Claim() // SM should be claimed beforehand, we just guarantee it's claimed.
+	sm.TryClaim() // SM should be claimed beforehand, we just guarantee it's claimed.
 	const nbits = 8
 	// https://github.com/raspberrypi/pico-examples/blob/eca13acf57916a0bd5961028314006983894fc84/pio/spi/spi.pio#L46
 	if !sm.IsValid() {

rp2-pio/piolib/spi3w.go

@@ -32,7 +32,7 @@ func NewSPI3w(sm pio.StateMachine, dio, clk machine.Pin, baud uint32) (*SPI3w, e
 	}
 
 	// https://github.com/embassy-rs/embassy/blob/c4a8b79dbc927e46fcc71879673ad3410aa3174b/cyw43-pio/src/lib.rs#L90
-	sm.Claim() // SM should be claimed beforehand, we just guarantee it's claimed.
+	sm.TryClaim() // SM should be claimed beforehand, we just guarantee it's claimed.
 
 	Pio := sm.PIO()
 	offset, err := Pio.AddProgram(spi3wInstructions, spi3wOrigin)

rp2-pio/piolib/ws2812.go

@@ -15,7 +15,7 @@ type WS2812 struct {
 }
 
 func NewWS2812(sm pio.StateMachine, pin machine.Pin, baud uint32) (*WS2812, error) {
-	sm.Claim() // SM should be claimed beforehand, we just guarantee it's claimed.
+	sm.TryClaim() // SM should be claimed beforehand, we just guarantee it's claimed.
 	whole, frac, err := pio.ClkDivFromFrequency(baud, machine.CPUFrequency())
 	if err != nil {
 		return nil, err

rp2-pio/statemachine.go

@@ -25,7 +25,7 @@ func (sm StateMachine) Unclaim() { sm.pio.claimedSMMask &^= (1 << sm.index) }
 
 // Claim attempts to claim the state machine for use by the caller and returns
 // true if successful, or false if StateMachine already claimed.
-func (sm StateMachine) Claim() bool {
+func (sm StateMachine) TryClaim() bool {
 	if sm.IsClaimed() {
 		return false
 	}