IC specific functions

The IC specific functions. More...

Functions
__inline bool	is_ic_supported (_dut_ic dut_ic)
	Query if the IC is supported by current PLT version. More...
__inline _ic_spec_status	get_dut_ic_str (_dut_ic dut_ic, char *str)
	Return the dut_ic string resolution. More...
__inline _ic_spec_status	get_dut_ic_enum (_dut_ic *dut_ic, char *str)
	Return the dut_ic enumeration value from the string equivalent. More...
__inline _ic_spec_status	get_dut_ic_prod_test_fw (_dut_ic dut_ic, char *file_name)
	Returns the production firmware file name for the given device IC. More...
__inline _ic_spec_status	get_dut_ic_mem_prog_fw (_dut_ic dut_ic, char *file_name)
	Returns the memory programming firmware file name for the given device IC. More...
__inline _ic_spec_status	check_gpio (_dut_ic dut_ic, _ic_gpio gpio_sel)
	Check if a GPIO port/pin configuration is valid. More...
__inline _ic_spec_status	get_gpio_name_str (_dut_ic dut_ic, _ic_gpio gpio, char *str)
	Return the selected GPIO in a string. More...
__inline _ic_spec_status	check_gpio_is_led (_dut_ic dut_ic, _ic_gpio gpio)
	Return whether the selected GPIO in an LED. More...

Detailed Description

The IC specific functions.

Function Documentation

check_gpio()

__inline _ic_spec_status check_gpio	(	_dut_ic	dut_ic,
		_ic_gpio	gpio_sel
	)

Check if a GPIO port/pin configuration is valid.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[in]	gpio_sel	Union that holds the selected GPIO of all IC types, __ic_gpio.

Returns

__ic_spec_status codes.

Definition at line 589 of file ic_specifics.h.

check_gpio_is_led()

__inline _ic_spec_status check_gpio_is_led	(	_dut_ic	dut_ic,
		_ic_gpio	gpio
	)

Return whether the selected GPIO in an LED.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[in]	gpio	Union that holds the selected GPIO of all IC types, __ic_gpio.

Returns

__ic_spec_status codes.

Definition at line 708 of file ic_specifics.h.

get_dut_ic_enum()

__inline _ic_spec_status get_dut_ic_enum	(	_dut_ic *	dut_ic,
		char *	str
	)

Return the dut_ic enumeration value from the string equivalent.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[out]	str	String to be updated.

Returns

__ic_spec_status codes.

Definition at line 480 of file ic_specifics.h.

get_dut_ic_mem_prog_fw()

__inline _ic_spec_status get_dut_ic_mem_prog_fw	(	_dut_ic	dut_ic,
		char *	file_name
	)

Returns the memory programming firmware file name for the given device IC.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[out]	file_name	String to be updated.

Returns

__ic_spec_status codes.

Definition at line 556 of file ic_specifics.h.

get_dut_ic_prod_test_fw()

__inline _ic_spec_status get_dut_ic_prod_test_fw	(	_dut_ic	dut_ic,
		char *	file_name
	)

Returns the production firmware file name for the given device IC.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[out]	file_name	String to be updated.

Returns

__ic_spec_status codes.

Definition at line 522 of file ic_specifics.h.

get_dut_ic_str()

__inline _ic_spec_status get_dut_ic_str	(	_dut_ic	dut_ic,
		char *	str
	)

Return the dut_ic string resolution.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[out]	str	String to be updated.

Returns

__ic_spec_status codes.

Definition at line 442 of file ic_specifics.h.

get_gpio_name_str()

__inline _ic_spec_status get_gpio_name_str	(	_dut_ic	dut_ic,
		_ic_gpio	gpio,
		char *	str
	)

Return the selected GPIO in a string.

Parameters

[in]	dut_ic	The type of device currently used, __dut_ic.
[in]	gpio	Union that holds the selected GPIO of all IC types, __ic_gpio.
[out]	str	String to be updated.

Returns

__ic_spec_status codes.

Definition at line 624 of file ic_specifics.h.

is_ic_supported()

__inline bool is_ic_supported

(

_dut_ic

dut_ic

)

Query if the IC is supported by current PLT version.

Parameters

dut_ic

The DUT IC to check.

Returns

True if the IC supported, false if not.

Definition at line 417 of file ic_specifics.h.