Device features

Manage device features. More...

Data Structures
struct	ProfisharkAPIDeviceFeatures
	Profishark device features. More...
struct	ProfisharkAPIDevicePortSpeed
	Profishark port speed. More...
struct	ProfisharkAPIDevicePortsSpeed
	Profishark ports speed. More...

Enumerations
enum	ProfisharkAPITimestampMoment { ProfisharkAPITimestampMoment_Capture, ProfisharkAPITimestampMoment_Ingress, ProfisharkAPITimestampMoment_Egress }
	Defines when the timestamp information is added to the packet. More...

Functions
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetDeviceFeatures (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceFeatures &features)
	Get device features. More...
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISetDeviceFeatures (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceFeatures features)
	Set device features. More...
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetHwFirmwaresDesc (ProfisharkApiDeviceHandle handle, ProfisharkAPIDeviceHWFirmwaresDesc &desc)
	Get the name corresponding to a HW firmware id. More...
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISetDevicePortsSpeed (ProfisharkApiDeviceHandle handle, ProfisharkAPIDevicePortsSpeed speed)
	Set network ports supported speeds. More...
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIGetDevicePortsSpeed (ProfisharkApiDeviceHandle handle, ProfisharkAPIDevicePortsSpeed &speed)
	Get network ports supported speeds. More...
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPISaveDeviceFeatures (ProfisharkApiDeviceHandle handle)
	Save device features and ports speed to EEPROM. More...
PROFISHARKAPI_API ProfisharkAPIRet	ProfisharkAPIRestartDevice (ProfisharkApiDeviceHandle handle)
	Restart the device. More...

Detailed Description

Manage device features.

Enumeration Type Documentation

enum ProfisharkAPITimestampMoment

Defines when the timestamp information is added to the packet.

Enumerator
ProfisharkAPITimestampMoment_Capture	Timestamp is applied at capture (default)
ProfisharkAPITimestampMoment_Ingress	Timestamp is applied on packet ingress
ProfisharkAPITimestampMoment_Egress	Timestamp is applied on packet egress

Function Documentation

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDeviceFeatures	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDeviceFeatures &	features
	)

Get device features.

Parameters

	handle	a handle to the device
[out]	features	a ProfisharkAPIDeviceFeatures that will be filled by the information from the driver

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetDevicePortsSpeed	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDevicePortsSpeed &	speed
	)

Get network ports supported speeds.

Parameters

handle	a handle to the device
speed	a ProfisharkAPIDevicePortsSpeed that will be filled with supported speeds

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIGetHwFirmwaresDesc	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDeviceHWFirmwaresDesc &	desc
	)

Get the name corresponding to a HW firmware id.

Parameters

handle	a handle to the device
desc	a ProfisharkAPIDeviceHWFirmwareDesc that will hold firmware descriptions

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPIRestartDevice

(

ProfisharkApiDeviceHandle

handle

)

Restart the device.

Parameters

handle

a handle to the device

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISaveDeviceFeatures

(

ProfisharkApiDeviceHandle

handle

)

Save device features and ports speed to EEPROM.

Parameters

handle

a handle to the device

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDeviceFeatures	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDeviceFeatures	features
	)

Set device features.

Parameters

handle	a handle to the device
features	a ProfisharkAPIDeviceFeatures containing features to set

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist
ProfisharkAPIRet_InvalidFirmware	if the selected HW firmware id is not valid

PROFISHARKAPI_API ProfisharkAPIRet ProfisharkAPISetDevicePortsSpeed	(	ProfisharkApiDeviceHandle	handle,
		ProfisharkAPIDevicePortsSpeed	speed
	)

Set network ports supported speeds.

Parameters

handle	a handle to the device
speed	a ProfisharkAPIDevicePortsSpeed describing the supported speeds

Return values

ProfisharkAPIRet_Success	on success
ProfisharkAPIRet_NoDev	if the device does not exist