Ucs_Return_t Ucs_Gpio_CreatePort	(	Ucs_Inst_t *	self,
		uint16_t	destination_address,
		uint8_t	index,
		uint16_t	debounce_time,
		Ucs_Gpio_CreatePortResCb_t	result_fptr
	)

Creates the GPIO port with its associated port instance identifier.

This function corresponds with the INIC function INIC.GPIOPortCreate.

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
index	The index of the GPIO Port instance.   Index
debounce_time	The timeout for the GPIO debounce timer (in ms).   DebounceTime
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_CreatePort(UCS_ADDR_LOCAL_DEV, 0x00U, 0x0003U, &App_GpioCreatePortResCb);
    if (result != UCS_RET_SUCCESS)
    {
        // Error handling here 
    }
}

// The GPIO CreatePort event handler function
// Handle GpioCreatePort event
static void App_GpioCreatePortResCb(uint16_t device_id, uint16_t port_handle, Ucs_Gpio_Result_t result, void * user_ptr)
{
    if (result.code == UCS_GPIO_RES_SUCCESS)
    {
        // Store received port handle
    }
    else
    {
        // Error handling here
    }
}