<br />

Added: 25

## **PROTOCOLS**

## PinImpl

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=23)*

This protocol combines the functionality of fuchsia.hardware.gpio.Gpio and
fuchsia.hardware.pin.Pin, accepting a number indicating the pin to act on. See those protocol
definitions for details on specific methods.

A PinImpl server must support at least one client connection. The server should release all
interrupts returned by `GetInterrupt()` if the client that requested the interrupts disconnects.

Common error codes:

- `ZX_ERR_NOT_FOUND`: No pin exists with number `pin`.
- `ZX_ERR_NOT_SUPPORTED`: The requested operation is not supported by this controller.
- `ZX_ERR_WRONG_TYPE`: If the pin does not support GPIO.

<br />

### Configure

#### Request

| Name | Type |
|---|---|
| `pin` | `uint32` |
| `config` | `https://fuchsia.dev/reference/fuchsia.hardware.pin//https://fuchsia.dev/reference/fuchsia.hardware.pin#Configuration` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_Configure_Result` |

### ConfigureInterrupt

#### Request

| Name | Type |
|---|---|
| `pin` | `uint32` |
| `config` | `https://fuchsia.dev/reference/fuchsia.hardware.gpio//https://fuchsia.dev/reference/fuchsia.hardware.gpio#InterruptConfiguration` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_ConfigureInterrupt_Result` |

### GetInterrupt

The PinImpl server should create a new interrupt object for each call to `GetInterrupt()`.
The interrupt corresponding to `pin` should be unmasked prior to being returned to the
caller.

#### Request

| Name | Type |
|---|---|
| `pin` | `uint32` |
| `options` | `https://fuchsia.dev/reference/fuchsia.hardware.gpio//https://fuchsia.dev/reference/fuchsia.hardware.gpio#InterruptOptions` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_GetInterrupt_Result` |

### Read

#### Request

| Name | Type |
|---|---|
| `pin` | `uint32` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_Read_Result` |

### ReleaseInterrupt

The PinImpl server should mask the interrupt corresponding to `pin`.

#### Request

| Name | Type |
|---|---|
| `pin` | `uint32` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_ReleaseInterrupt_Result` |

### SetBufferMode

#### Request

| Name | Type |
|---|---|
| `pin` | `uint32` |
| `mode` | `https://fuchsia.dev/reference/fuchsia.hardware.gpio//https://fuchsia.dev/reference/fuchsia.hardware.gpio#BufferMode` |

#### Response

| Name | Type |
|---|---|
| `payload` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_SetBufferMode_Result` |

## **STRUCTS**

### Call

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=36)*

| Field | Type | Description | Default |
|---|---|---|---|
| `pin` | `uint32` | The platform-specific pin number that this call operates on. | No default |
| `call` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#InitCall` | The call to make and the arguments to pass to it. | No default |

### DevicePinStates

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=60)*
Added: HEAD

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `name` | `string:64` |   | No default |
| `states` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinState>` |   | No default |
| `id` | `uint32` |   | No default |

### PinConfiguration

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=48)*
Added: HEAD

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `pin` | `uint32` |   | No default |
| `call` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#InitCall` |   | No default |

### PinImpl_ConfigureInterrupt_Response

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=38)*

\<EMPTY\>

### PinImpl_Configure_Response

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=58)*

| Field | Type | Description | Default |
|---|---|---|---|
| `new_config` | `https://fuchsia.dev/reference/fuchsia.hardware.pin//https://fuchsia.dev/reference/fuchsia.hardware.pin#Configuration` |   | No default |

### PinImpl_GetInterrupt_Response [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=46)*

| Field | Type | Description | Default |
|---|---|---|---|
| `interrupt` | `handle<interrupt>` |   | No default |

### PinImpl_Read_Response

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=26)*

| Field | Type | Description | Default |
|---|---|---|---|
| `value` | `bool` |   | No default |

### PinImpl_ReleaseInterrupt_Response

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=53)*

\<EMPTY\>

### PinImpl_SetBufferMode_Response

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=33)*

\<EMPTY\>

### PinState

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=54)*
Added: HEAD

<br />

| Field | Type | Description | Default |
|---|---|---|---|
| `name` | `string:64` |   | No default |
| `pins` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinConfiguration>` |   | No default |

## **TABLES**

### Metadata

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=67)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `init_steps` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#InitStep>` | Init steps are processed sequentially in the order that they appear in the vector. Processing occurs once during the GPIO core driver's start hook. |
| ### 2 | `controller_id` | `uint32` |   |
| ### 3 | `pins` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#Pin>` |   |
| ### 4 | `device_pin_states` | `vector<https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#DevicePinStates>` | Added: HEAD |

### Pin

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=17)*

| Ordinal | Field | Type | Description |
|---|---|---|---|
| ### 1 | `pin` | `uint32` |   |
| ### 2 | `name` | `string:64` |   |
| ### 3 | `id` | `uint32` | Added: HEAD |

## **UNIONS**

### InitCall [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=25)*

Arguments to a fuchsia.hardware.pinimpl.PinImpl call to make as part of an `InitStep`.

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `pin_config` | `https://fuchsia.dev/reference/fuchsia.hardware.pin//https://fuchsia.dev/reference/fuchsia.hardware.pin#Configuration` | If set, the GPIO core driver will call \`Configure' with the given config. |
| ### 2 | `buffer_mode` | `https://fuchsia.dev/reference/fuchsia.hardware.gpio//https://fuchsia.dev/reference/fuchsia.hardware.gpio#BufferMode` | If set, the GPIO core driver will call `SetBufferMode` with the given mode. |

<br />

### InitStep [flexible](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/metadata.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=33)*

A single init step to be performed by the GPIO core driver.

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `call` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#Call` | If set, the GPIO core driver will make a call to the PinImpl driver with the given pin and arguments. |
| ### 2 | `delay` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Duration` | If set, the GPIO core driver will delay for this long before processing the next step. |

<br />

### PinImpl_ConfigureInterrupt_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=38)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_ConfigureInterrupt_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### PinImpl_Configure_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=58)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_Configure_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### PinImpl_GetInterrupt_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible) [resource](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#value-vs-resource)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=46)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_GetInterrupt_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### PinImpl_Read_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=26)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_Read_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### PinImpl_ReleaseInterrupt_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=53)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_ReleaseInterrupt_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

### PinImpl_SetBufferMode_Result [strict](https://fuchsia.dev/fuchsia-src/reference/fidl/language/language#strict-vs-flexible)

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=33)*

| Ordinal | Variant | Type | Description |
|---|---|---|---|
| ### 1 | `response` | `https://fuchsia.dev/reference/fidl/fuchsia.hardware.pinimpl#PinImpl_SetBufferMode_Response` |   |
| ### 2 | `err` | `https://fuchsia.dev/reference/zx//https://fuchsia.dev/reference/zx#Status` |   |

<br />

## **CONSTANTS**

| Name | Value | Type | Description |
|---|---|---|---|
| [MAX_DEVICE_NAME_LEN](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=15) | `64` | `uint32` | Added: HEAD |
| [METADATA_TYPE_NAME](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/metadata.fidl;l=12) | `fuchsia.hardware.pinimpl.Metadata` | `String` | **DEPRECATED**- Unused |

## **SERVICES**

### Service

*Defined in [fuchsia.hardware.pinimpl/pin-impl.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=63)*

| Name | Type | Transport |
|---|---|---|
| [device](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.hardware.pinimpl/pin-impl.fidl;l=64) | `fuchsia.hardware.pinimpl/PinImpl` | Driver |

<br />