Synopsis

typedef enum {
  PIN_CLAIM_WEAK,
  PIN_CLAIM_SHARED,
  PIN_CLAIM_EXCLUSIVE,
  PIN_CLAIM_FIXED,
  PIN_CLAIM_LOCKED
} PLATFORM_PIN_CLAIM_t;

Description

PLATFORM_PIN_CLAIM_t describes the claim that the client wishes to make on a pin when configuring it using platform_claim_pin or platform_claim_pin_configuration.

PIN_CLAIM_WEAK

The application claims this pin for a function but the pin can be reconfigured for another function without first releasing it.

PIN_CLAIM_SHARED

The application claims this pin for a function, and claims of the same pin for the same function will be granted. The pin can be released for reuse by platform_release_pin.

PIN_CLAIM_EXCLUSIVE

The application claims exclusive use of this pin for a function, and claims of the same pin for the same function will be denied. The pin can be released for reuse by platform_release_pin.

PIN_CLAIM_FIXED

The application claims exclusive use of this pin for a function, claims of the same pin for the same function will be denied. Fixed pins cannot be released.

PIN_CLAIM_LOCKED

As PIN_CLAIM_FIXED but used internally by the Platform Library to deny configuration of dedicated or non-existent pins. Locked pins cannot be released. If the underlying microcontroller implements pin locks, the Platform Library may take advantage of this and hardware-lock the pin in addition to locking it in software.

See Also

platform_claim_pin, platform_claim_pin_configuration