Merge pull request #13 from ZaparooProject/fix/windows-uart-compatibility

feat: enhance Windows UART compatibility with platform-specific handling

Author: wizzomafizzo

.github/workflows/ci.yml

@@ -12,6 +12,7 @@ permissions:
 jobs:
   test:
     strategy:
+      fail-fast: false
       matrix:
         go-version: ['1.24.x']
         os: [ubuntu-latest, macos-latest, windows-latest]
@@ -43,6 +44,7 @@ jobs:
 
   integration:
     strategy:
+      fail-fast: false
       matrix:
         go-version: ['1.24.x']
         os: [ubuntu-latest, macos-latest, windows-latest]

communication_test.go

@@ -185,7 +185,7 @@ func getDataExchangeErrorCases() []struct {
 			},
 			inputData:      []byte{0x01, 0x02},
 			expectError:    true,
-			errorSubstring: "PN532 error: 0x01",
+			errorSubstring: "PN532 error 0x01",
 		},
 		{
 			name: "Invalid_Response_Format",
@@ -325,7 +325,7 @@ func getRawCommandErrorCases() []struct {
 			},
 			inputData:      []byte{0x30, 0x00},
 			expectError:    true,
-			errorSubstring: "PN532 error: 0x02",
+			errorSubstring: "PN532 error 0x02",
 		},
 		{
 			name: "Invalid_Response_Format",

device.go

@@ -408,6 +408,57 @@ func (d *Device) IsAutoPollSupported() bool {
 	return d.hasCapability(CapabilityAutoPollNative)
 }
 
+// SetPassiveActivationRetries configures the maximum number of retries for passive activation
+// to prevent infinite waiting that can cause the PN532 to lock up. A finite number like 10 (0x0A)
+// is recommended instead of 0xFF (infinite) to avoid stuck states requiring power cycling.
+func (d *Device) SetPassiveActivationRetries(maxRetries byte) error {
+	// RF Configuration item 0x05 - MaxRetries
+	// Payload: [MxRtyATR, MxRtyPSL, MxRtyPassiveActivation]
+	configPayload := []byte{
+		0x05,       // CfgItem: MaxRetries
+		0x00,       // MxRtyATR (use default)
+		0x00,       // MxRtyPSL (use default)
+		maxRetries, // MxRtyPassiveActivation
+	}
+
+	_, err := d.transport.SendCommand(cmdRFConfiguration, configPayload)
+	if err != nil {
+		return fmt.Errorf("failed to set passive activation retries: %w", err)
+	}
+
+	return nil
+}
+
+// SetPollingRetries configures the MxRtyATR parameter for passive target detection retries.
+// This controls how many times the PN532 will retry detecting a passive target before giving up.
+// Each retry is approximately 150ms according to the PN532 datasheet.
+//
+// Parameters:
+//   - mxRtyATR: Number of retries (0x00 = immediate, 0x01-0xFE = retry count, 0xFF = infinite)
+//
+// Common values:
+//   - 0x00: Immediate return (no retries)
+//   - 0x10: ~2.4 seconds (16 retries)
+//   - 0x20: ~4.8 seconds (32 retries)
+//   - 0xFF: Infinite retries (use with caution)
+func (d *Device) SetPollingRetries(mxRtyATR byte) error {
+	// RF Configuration item 0x05 - MaxRetries
+	// Payload: [MxRtyATR, MxRtyPSL, MxRtyPassiveActivation]
+	configPayload := []byte{
+		0x05,     // CfgItem: MaxRetries
+		mxRtyATR, // MxRtyATR (retry count for passive target detection)
+		0x01,     // MxRtyPSL (default)
+		0xFF,     // MxRtyPassiveActivation (infinite)
+	}
+
+	_, err := d.transport.SendCommand(cmdRFConfiguration, configPayload)
+	if err != nil {
+		return fmt.Errorf("failed to set polling retries: %w", err)
+	}
+
+	return nil
+}
+
 // Close closes the device connection
 func (d *Device) Close() error {
 	if d.transport != nil {

device_context.go

@@ -45,6 +45,14 @@ func (d *Device) InitContext(ctx context.Context) error {
 		}
 	}
 
+	// Configure finite passive activation retries to prevent infinite wait lockups
+	// Use 10 retries (~1 second) instead of default 0xFF (infinite)
+	if err := d.SetPassiveActivationRetries(0x0A); err != nil {
+		// Log but don't fail initialization - this is an optimization, not critical
+		// Some older firmware versions might not support this configuration
+		_ = err
+	}
+
 	// Get firmware version (if supported by transport)
 	if !skipFirmwareVersion {
 		if err := d.setupFirmwareVersion(ctx); err != nil {
@@ -370,6 +378,20 @@ func (d *Device) detectTagsWithInListPassiveTarget(
 		return nil, fmt.Errorf("transport preparation failed: %w", err)
 	}
 
+	// Release any previously selected targets to clear HALT states
+	// This addresses intermittent "empty valid tag" issues where tags get stuck
+	if err := d.InReleaseContext(ctx, 0); err != nil {
+		debugf("InRelease failed, continuing anyway: %v", err)
+		// Don't fail the operation if InRelease fails - it's an optimization
+	}
+
+	// Small delay to allow RF field and tags to stabilize after release
+	select {
+	case <-ctx.Done():
+		return nil, ctx.Err()
+	case <-time.After(10 * time.Millisecond):
+	}
+
 	// Use InListPassiveTarget for legacy compatibility
 	return d.InListPassiveTargetContext(ctx, maxTags, baudRate)
 }
@@ -549,7 +571,7 @@ func (d *Device) SendDataExchangeContext(ctx context.Context, data []byte) ([]by
 	// Check for error frame (TFI = 0x7F)
 	if len(res) >= 2 && res[0] == 0x7F {
 		errorCode := res[1]
-		return nil, fmt.Errorf("PN532 error: 0x%02X", errorCode)
+		return nil, NewPN532Error(errorCode, "InDataExchange", "")
 	}
 
 	if len(res) < 2 || res[0] != 0x41 {
@@ -571,7 +593,7 @@ func (d *Device) SendRawCommandContext(ctx context.Context, data []byte) ([]byte
 	// Check for error frame (TFI = 0x7F)
 	if len(res) >= 2 && res[0] == 0x7F {
 		errorCode := res[1]
-		return nil, fmt.Errorf("PN532 error: 0x%02X", errorCode)
+		return nil, NewPN532Error(errorCode, "InCommunicateThru", "")
 	}
 
 	if len(res) < 2 || res[0] != 0x43 {
@@ -750,13 +772,93 @@ func (*Device) normalizeMaxTargets(maxTg byte) byte {
 
 // executeInListPassiveTarget sends the InListPassiveTarget command
 func (d *Device) executeInListPassiveTarget(ctx context.Context, data []byte) ([]byte, error) {
+	// Dynamically adjust transport timeout based on mxRtyATR when provided
+	// mxRtyATR is the 3rd byte of the InListPassiveTarget payload
+	var prevTimeout time.Duration
+	if d.config != nil {
+		prevTimeout = d.config.Timeout
+	}
+	computed := d.computeInListHostTimeout(ctx, data)
+	// Best-effort set; if it fails we'll proceed with previous timeout
+	_ = d.transport.SetTimeout(computed)
+	// Restore previous timeout after the command completes
+	defer func() { _ = d.transport.SetTimeout(prevTimeout) }()
+
 	result, err := d.transport.SendCommandWithContext(ctx, cmdInListPassiveTarget, data)
 	if err != nil {
 		return nil, fmt.Errorf("failed to send InListPassiveTarget command: %w", err)
 	}
 	return result, nil
 }
 
+// computeInListHostTimeout derives a host-side timeout from mxRtyATR and context deadline
+// According to PN532 docs, each retry is ~150ms. We add baseline slack and bound by context if present.
+func (d *Device) computeInListHostTimeout(ctx context.Context, data []byte) time.Duration {
+	var fallback time.Duration
+	if d.config != nil {
+		fallback = d.config.Timeout
+	}
+
+	// When mxRtyATR (3rd byte) is provided, derive a timeout from it.
+	if len(data) >= 3 {
+		return d.computeTimeoutFromRetryCount(ctx, data[2], fallback)
+	}
+
+	// No mxRtyATR provided; use context deadline if present or fallback
+	return d.getContextTimeoutOrFallback(ctx, fallback)
+}
+
+// computeTimeoutFromRetryCount calculates timeout based on mxRtyATR retry count
+func (d *Device) computeTimeoutFromRetryCount(ctx context.Context, mx byte, fallback time.Duration) time.Duration {
+	// 0xFF means infinite retry on hardware; rely on context or cap to a safe upper bound
+	if mx == 0xFF {
+		return d.handleInfiniteRetry(ctx)
+	}
+
+	// Each retry ~150ms; add small baseline slack for host/driver overhead
+	expected := time.Duration(int(mx))*150*time.Millisecond + 300*time.Millisecond
+
+	// Apply bounds and respect context deadline
+	return d.applyTimeoutBounds(ctx, expected, fallback)
+}
+
+// handleInfiniteRetry handles the special case of infinite retry (0xFF)
+func (*Device) handleInfiniteRetry(ctx context.Context) time.Duration {
+	if deadline, ok := ctx.Deadline(); ok {
+		if rem := time.Until(deadline); rem > 0 {
+			return rem
+		}
+	}
+	// No deadline; choose a conservative cap
+	return 10 * time.Second
+}
+
+// applyTimeoutBounds ensures timeout is within reasonable bounds and respects context
+func (d *Device) applyTimeoutBounds(ctx context.Context, expected, fallback time.Duration) time.Duration {
+	// Ensure we don't go below device default
+	if expected < fallback {
+		expected = fallback
+	}
+
+	// Cap to a reasonable maximum to avoid excessive blocking when mx is large
+	if expected > 8*time.Second {
+		expected = 8 * time.Second
+	}
+
+	// Respect context deadline if sooner
+	return d.getContextTimeoutOrFallback(ctx, expected)
+}
+
+// getContextTimeoutOrFallback returns context deadline if present and positive, otherwise fallback
+func (*Device) getContextTimeoutOrFallback(ctx context.Context, fallback time.Duration) time.Duration {
+	if deadline, ok := ctx.Deadline(); ok {
+		if rem := time.Until(deadline); rem > 0 && rem < fallback {
+			return rem
+		}
+	}
+	return fallback
+}
+
 // handleInListPassiveTargetError handles command errors with clone device fallback
 func (d *Device) handleInListPassiveTargetError(
 	ctx context.Context, err error, maxTg, brTy byte,

device_context_test.go

@@ -89,3 +89,128 @@ func TestDiagnoseContextCancellation(t *testing.T) {
 	assert.ErrorIs(t, err, context.DeadlineExceeded,
 		"Expected context.DeadlineExceeded, got: %v", err)
 }
+
+// TestDetectTagsWithInListPassiveTarget_CallsInRelease tests that tag detection calls InRelease first
+func TestDetectTagsWithInListPassiveTarget_CallsInRelease(t *testing.T) {
+	t.Parallel()
+
+	mock := NewMockTransport()
+	defer func() { _ = mock.Close() }()
+
+	// Set up successful InRelease response (command 0x52)
+	mock.SetResponse(0x52, []byte{0x53, 0x00}) // InRelease response + success status
+
+	// Set up successful InListPassiveTarget response (command 0x4A)
+	mock.SetResponse(0x4A, []byte{
+		0x4B,       // InListPassiveTarget response
+		0x01,       // Number of targets found
+		0x01,       // Target number
+		0x00, 0x04, // SENS_RES
+		0x08,                   // SEL_RES
+		0x04,                   // UID length
+		0x12, 0x34, 0x56, 0x78, // UID
+	})
+
+	device, err := New(mock)
+	require.NoError(t, err)
+
+	// Call the internal detectTagsWithInListPassiveTarget method
+	tags, err := device.detectTagsWithInListPassiveTarget(context.Background(), 1, 0x00)
+
+	require.NoError(t, err)
+	require.Len(t, tags, 1)
+	require.Equal(t, "12345678", tags[0].UID)
+
+	// Note: We set up both InRelease and InListPassiveTarget responses above.
+	// The fact that the detection succeeded implies both were called successfully.
+	// We can't easily verify the exact call order without modifying MockTransport,
+	// but the behavior test (success with proper setup) is sufficient.
+}
+
+// TestDetectTagsWithInListPassiveTarget_InReleaseFails tests behavior when InRelease fails
+func TestDetectTagsWithInListPassiveTarget_InReleaseFails(t *testing.T) {
+	t.Parallel()
+
+	mock := NewMockTransport()
+	defer func() { _ = mock.Close() }()
+
+	// Set up InRelease failure (command 0x52)
+	mock.SetError(0x52, ErrTransportTimeout)
+
+	// Set up successful InListPassiveTarget response despite InRelease failure
+	mock.SetResponse(0x4A, []byte{
+		0x4B,       // InListPassiveTarget response
+		0x01,       // Number of targets found
+		0x01,       // Target number
+		0x00, 0x04, // SENS_RES
+		0x08,                   // SEL_RES
+		0x04,                   // UID length
+		0x12, 0x34, 0x56, 0x78, // UID
+	})
+
+	device, err := New(mock)
+	require.NoError(t, err)
+
+	// Call should succeed even if InRelease fails
+	tags, err := device.detectTagsWithInListPassiveTarget(context.Background(), 1, 0x00)
+
+	require.NoError(t, err, "Tag detection should succeed even when InRelease fails")
+	require.Len(t, tags, 1)
+	require.Equal(t, "12345678", tags[0].UID)
+}
+
+// TestDetectTagsWithInListPassiveTarget_WithContext_Cancellation tests context cancellation during delay
+func TestDetectTagsWithInListPassiveTarget_WithContext_Cancellation(t *testing.T) {
+	t.Parallel()
+
+	mock := NewMockTransport()
+	defer func() { _ = mock.Close() }()
+
+	// Set up successful InRelease response
+	mock.SetResponse(0x52, []byte{0x53, 0x00})
+
+	device, err := New(mock)
+	require.NoError(t, err)
+
+	// Create a context that will be cancelled quickly
+	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Millisecond)
+	defer cancel()
+
+	// This should fail due to context cancellation during the delay
+	_, err = device.detectTagsWithInListPassiveTarget(ctx, 1, 0x00)
+
+	require.Error(t, err)
+	assert.ErrorIs(t, err, context.DeadlineExceeded, "Should fail with context deadline exceeded")
+}
+
+// TestDetectTagsWithInListPassiveTarget_Timing tests that there's a delay after InRelease
+func TestDetectTagsWithInListPassiveTarget_Timing(t *testing.T) {
+	t.Parallel()
+
+	mock := NewMockTransport()
+	defer func() { _ = mock.Close() }()
+
+	// Set up responses
+	mock.SetResponse(0x52, []byte{0x53, 0x00}) // InRelease
+	mock.SetResponse(0x4A, []byte{
+		0x4B,       // InListPassiveTarget response
+		0x01,       // Number of targets found
+		0x01,       // Target number
+		0x00, 0x04, // SENS_RES
+		0x08,                   // SEL_RES
+		0x04,                   // UID length
+		0x12, 0x34, 0x56, 0x78, // UID
+	})
+
+	device, err := New(mock)
+	require.NoError(t, err)
+
+	start := time.Now()
+	_, err = device.detectTagsWithInListPassiveTarget(context.Background(), 1, 0x00)
+	elapsed := time.Since(start)
+
+	require.NoError(t, err)
+	// Should have some delay (at least 5ms) due to the stabilization delay
+	assert.GreaterOrEqual(t, elapsed, 5*time.Millisecond,
+		"Should have a delay of at least 5ms for RF field stabilization")
+}