ArvUvcp

ArvUvcp — USB3Vision control packet handling

Functions

Types and Values

Description

Functions

arv_uvcp_packet_new_read_memory_cmd ()

ArvUvcpPacket *
arv_uvcp_packet_new_read_memory_cmd (guint64 address,
                                     guint32 size,
                                     guint16 packet_id,
                                     size_t *packet_size);

[skip]

Parameters

address

read address

 

size

read size, in bytes

 

packet_id

packet id

 

packet_size

packet size, in bytes.

[out]

Returns

a new ArvUvcpPacket

Create a uvcp packet for a memory read command.

[transfer full]


arv_uvcp_packet_new_write_memory_cmd ()

ArvUvcpPacket *
arv_uvcp_packet_new_write_memory_cmd (guint64 address,
                                      guint32 size,
                                      guint16 packet_id,
                                      size_t *packet_size);

[skip]

Parameters

address

write address

 

size

write size, in bytes

 

packet_id

packet id

 

packet_size

packet size, in bytes.

[out]

Returns

a new ArvUvcpPacket

Create a uvcp packet for a memory write command.

[transfer full]


arv_uvcp_packet_free ()

void
arv_uvcp_packet_free (ArvUvcpPacket *packet);

arv_uvcp_packet_get_command ()

ArvUvcpCommand
arv_uvcp_packet_get_command (ArvUvcpPacket *packet);

Parameters

packet

a ArvUvcpPacket

 

Returns

The ArvUvcpCommand code of packet .


arv_uvcp_packet_get_packet_id ()

guint16
arv_uvcp_packet_get_packet_id (ArvUvcpPacket *packet);

arv_uvcp_packet_set_packet_id ()

void
arv_uvcp_packet_set_packet_id (ArvUvcpPacket *packet,
                               guint16 id);

arv_uvcp_packet_get_packet_type ()

ArvUvcpPacketType
arv_uvcp_packet_get_packet_type (ArvUvcpPacket *packet);

Parameters

packet

a ArvUvcpPacket

 

Returns

The ArvUvcpPacketType code of packet .


arv_uvcp_packet_get_pending_ack_timeout ()

guint16
arv_uvcp_packet_get_pending_ack_timeout
                               (ArvUvcpPacket *packet);

arv_uvcp_packet_get_read_memory_ack_data ()

void *
arv_uvcp_packet_get_read_memory_ack_data
                               (const ArvUvcpPacket *packet);

arv_uvcp_packet_get_read_memory_ack_size ()

size_t
arv_uvcp_packet_get_read_memory_ack_size
                               (size_t data_size);

arv_uvcp_packet_get_write_memory_ack_size ()

size_t
arv_uvcp_packet_get_write_memory_ack_size
                               (void);

arv_uvcp_packet_get_write_memory_cmd_data ()

void *
arv_uvcp_packet_get_write_memory_cmd_data
                               (const ArvUvcpPacket *packet);

arv_uvcp_next_packet_id ()

guint16
arv_uvcp_next_packet_id (guint16 packet_id);

arv_uvcp_packet_debug ()

void
arv_uvcp_packet_debug (const ArvUvcpPacket *packet,
                       ArvDebugLevel level);

Dumps the content of packet if level is lower or equal to the current debug level for the cp debug category. See arv_debug_enable().

Parameters

packet

a ArvUvcpPacket

 

level

debug level

 

arv_uvcp_packet_to_string ()

char *
arv_uvcp_packet_to_string (const ArvUvcpPacket *packet);

Converts packet into a human readable string.

Parameters

packet

a ArvUvcpPacket

 

Returns

A newly allocated string.

[transfer full]


arv_uvcp_command_to_string ()

const char *
arv_uvcp_command_to_string (ArvUvcpCommand value);

arv_uvcp_packet_type_to_string ()

const char *
arv_uvcp_packet_type_to_string (ArvUvcpPacketType value);

arv_uvcp_manifest_entry_get_schema_type ()

ArvUvcpManifestSchemaType
arv_uvcp_manifest_entry_get_schema_type
                               (ArvUvcpManifestEntry *entry);

Types and Values

enum ArvUvcpCommand

Members

ARV_UVCP_COMMAND_READ_MEMORY_CMD

read memory command

 

ARV_UVCP_COMMAND_READ_MEMORY_ACK

read memory acknowledge

 

ARV_UVCP_COMMAND_WRITE_MEMORY_CMD

write memory command

 

ARV_UVCP_COMMAND_WRITE_MEMORY_ACK

write memory acknowledge

 

ARV_UVCP_COMMAND_PENDING_ACK

pending command acknowledge

 

ARV_UVCP_COMMAND_EVENT_CMD

event command

 

ArvUvcpPacket

typedef struct {
	ArvUvcpHeader header;
	unsigned char data[];
} ArvUvcpPacket;

UVCP packet structure.

Members

ArvUvcpHeader header;

packet header

 

unsigned char data[];

variable size byte array

 

enum ArvUvcpPacketType

Members

ARV_UVCP_PACKET_TYPE_ERROR

error packet

 

ARV_UVCP_PACKET_TYPE_ACK

acknowledge packet

 

ARV_UVCP_PACKET_TYPE_CMD

command packet

 

enum ArvUvcpManifestSchemaType

This is packed into the 32-bit schema type as bits 10-15

Members

ARV_UVCP_SCHEMA_RAW

uncompressed genicam data

 

ARV_UVCP_SCHEMA_ZIP

zipped genicam data