PLTD API functions

The API functions of the PLTD library. More...

Functions
PLTD_API int	pltd_init (void)
	PLTD library initialization function. More...
PLTD_API void	pltd_close (void)
	PLTD library close function. More...
PLTD_API int	pltd_set_device_params (const _pltd_dev_params *params)
	Sets the PLTD library specific device parameters. More...
PLTD_API int	pltd_set_general_params (const _pltd_general_params *pltd_general_params_t)
	Sets the PLTD library general programming parameters, common to all devices. More...
PLTD_API int	pltd_start (void)
	Starts the operation of the PLTD library. More...
PLTD_API int	pltd_com_port_enum (uint32_t *com_port_dut)
	Starts the enumeration of the DUT com ports. More...
PLTD_API int	pltd_gu_com_find (int *gu_com_port)
	Starts automated detection of the GU COM port. More...
PLTD_API int	pltd_gu_check_led (void)
	Checks whether the GU is active by toggling its LED at P10. More...
PLTD_API int	pltd_dbg_init (const _pltd_dbg_params *pltd_dbg_params_t)
	Debug settings. More...
PLTD_API char *	pltd_get_ble_tester_instr_names (const char *prev_name)
	Returns the names of the BLE tester instrument DLLs found. More...
PLTD_API char *	pltd_get_ammeter_instr_names (const char *prev_name)
	Returns the names of the ammeter instrument DLLs found. More...
PLTD_API char *	pltd_get_temp_meas_instr_names (const char *prev_name)
	Returns the names of the ammeter instrument DLLs found. More...
PLTD_API int	pltd_vbat_uart_set (bool start, uint16_t duts)
	Enables device VBAT and opens the device UART through the CPLD on the PLT hardware. More...
PLTD_API int	pltd_uart_coms_test (const _pltd_uart_test *uart_test)
	Test the UART communication path between the PC and the devices under test. More...
PLTD_API _pltd_versions *	pltd_get_versions (void)
	Returns the versions of all the PLTD software components. More...

Detailed Description

The API functions of the PLTD library.

Function Documentation

pltd_close()

PLTD_API void pltd_close

(

void

)

PLTD library close function.

Returns

void.

pltd_com_port_enum()

PLTD_API int pltd_com_port_enum

(

uint32_t *

com_port_dut

)

Starts the enumeration of the DUT com ports.

Parameters

[out]

com_port_dut

A pointer to the list of DUT com ports found.

Returns

PLTD API callback and function return status codes..

pltd_dbg_init()

PLTD_API int pltd_dbg_init

(

const _pltd_dbg_params *

pltd_dbg_params_t

)

Debug settings.

Parameters

[in]

pltd_dbg_params_t

A pointer to the a __pltd_dbg_params.

Returns

PLTD API callback and function return status codes..

pltd_get_ammeter_instr_names()

PLTD_API char * pltd_get_ammeter_instr_names

(

const char *

prev_name

)

Returns the names of the ammeter instrument DLLs found.

Parameters

[out]

prev_name

Set NULL to get the first instrument name. Set to the previous instrument name to get the next one.

Returns

PLTD API callback and function return status codes..

pltd_get_ble_tester_instr_names()

PLTD_API char * pltd_get_ble_tester_instr_names

(

const char *

prev_name

)

Returns the names of the BLE tester instrument DLLs found.

Parameters

[out]

prev_name

Set NULL to get the first instrument name. Set to the previous instrument name to get the next one.

Returns

PLTD API callback and function return status codes..

pltd_get_temp_meas_instr_names()

PLTD_API char * pltd_get_temp_meas_instr_names

(

const char *

prev_name

)

Returns the names of the ammeter instrument DLLs found.

Parameters

[out]

prev_name

NULL to get the first instrument name. Set to the previous instrument name to get the next one.

Returns

PLTD API callback and function return status codes..

pltd_get_versions()

PLTD_API _pltd_versions * pltd_get_versions

(

void

)

Returns the versions of all the PLTD software components.

Returns

__pltd_versions data structure.

pltd_gu_check_led()

PLTD_API int pltd_gu_check_led

(

void

)

Checks whether the GU is active by toggling its LED at P10.

Returns

PLTD API callback and function return status codes..

pltd_gu_com_find()

PLTD_API int pltd_gu_com_find

(

int *

gu_com_port

)

Starts automated detection of the GU COM port.

Parameters

[out]

gu_com_port

A pointer to the GU COM port number found.

Returns

PLTD API callback and function return status codes..

pltd_init()

PLTD_API int pltd_init

(

void

)

PLTD library initialization function.

Returns

PLTD API callback and function return status codes..

pltd_set_device_params()

PLTD_API int pltd_set_device_params

(

const _pltd_dev_params *

params

)

Sets the PLTD library specific device parameters.

Parameters

[in]

params

A pointer to a __pltd_dev_params data structure.

Returns

PLTD API callback and function return status codes..

pltd_set_general_params()

PLTD_API int pltd_set_general_params

(

const _pltd_general_params *

pltd_general_params_t

)

Sets the PLTD library general programming parameters, common to all devices.

Parameters

[in]

pltd_general_params_t

A pointer to a __pltd_general_params data structure.

Returns

PLTD API callback and function return status codes..

pltd_start()

PLTD_API int pltd_start

(

void

)

Starts the operation of the PLTD library.

Returns

PLTD API callback and function return status codes..

pltd_uart_coms_test()

PLTD_API int pltd_uart_coms_test

(

const _pltd_uart_test *

uart_test

)

Test the UART communication path between the PC and the devices under test.

Parameters

[in]

uart_test

A pointer to the UART test parameters taken from __pltd_uart_test.

Returns

PLTD API callback and function return status codes..

pltd_vbat_uart_set()

PLTD_API int pltd_vbat_uart_set	(	bool	start,
		uint16_t	duts
	)

Enables device VBAT and opens the device UART through the CPLD on the PLT hardware.

Parameters

[in]	start	Set to true at the first time this command is called. This will initialize CPLD and reset VBAT and UART connection.
[in]	duts	Each bit of this 16 bit value denotes a device. Setting bit0 to 1 will open VBAT and UART in PLT DUT connector 1. Value 0xFF1F will open VBAT and UART in all devices except 6, 7 and 8.

Returns

PLTD API callback and function return status codes..