Ucs_Return_t Ucs_Gpio_ReadPort	(	Ucs_Inst_t *	self,
		uint16_t	destination_address,
		uint16_t	gpio_port_handle,
		Ucs_Gpio_PinStateResCb_t	result_fptr
	)

Reads the pin state of the given GPIO port.

This function corresponds with the INIC function INIC.GPIOPortPinState.

Parameters

self	The UNICENS instance pointer
destination_address	Address of the target device. Use the UCS_ADDR_LOCAL_DEV macro to target the local device. The following address ranges are supported: [0x10 ... 0x2FF] [0x500 ... 0xFEF] UCS_ADDR_LOCAL_DEV
gpio_port_handle	The GPIO Port resource handle.   GPIOPortHandle
result_fptr	Required result callback function pointer.

Returns

Possible return values are shown in the table below.

Value	Description
UCS_RET_SUCCESS	No error
UCS_RET_ERR_PARAM	At least one parameter is wrong
UCS_RET_ERR_BUFFER_OVERFLOW	No message buffer available
UCS_RET_ERR_API_LOCKED	API is currently locked
UCS_RET_ERR_NOT_INITIALIZED	UNICENS is not initialized

Example

// Main function
void main()
{
    Ucs_Return_t result = Ucs_Gpio_ReadPort(UCS_ADDR_LOCAL_DEV, 0x1D00, &App_GpioReadPortResCb);
    if (result != UCS_RET_SUCCESS)
    {
        // Error handling here 
    }
}

// The event handler function
// Handle GpioReadPort event
static void App_GpioReadPortResCb(uint16_t device_id, uint16_t port_handle, uint16_t current_state, uint16_t sticky_state, Ucs_Gpio_Result_t result)
{
    if (result.code == UCS_GPIO_RES_SUCCESS)
    {
       // Do what needs to be..
    }
    else
    {
        // Error handling here
    }
}