titan.TestPorts.USB/src/USB_PortTypes.ttcn

module USB_PortTypes {

	type enumerated USB_transfer_status {
		USB_TRANSFER_COMPLETED,
		USB_TRANSFER_ERROR,
		USB_TRANSFER_TIMED_OUT,
		USB_TRANSFER_CANCELLED,
		USB_TRANSFER_STALL,
		USB_TRANSFER_NO_DEVIC,
		USB_TRANSFER_OVERFLOW
	};

	type integer USB_endpoint (0..255);
	type integer USB_vendor_id (0..65535);
	type integer USB_product_id (0..65535);

	type enumerated USB_transfer_type {
		USB_TRANSFER_TYPE_CONTROL,
		USB_TRANSFER_TYPE_ISOCHRONOUS,
		USB_TRANSFER_TYPE_BULK,
		USB_TRANSFER_TYPE_INTERRUPT,
		USB_TRANSFER_TYPE_BULK_STREAM
	};

	/* submit a USB transfer to the specified device / endpoint */
	type record USB_transfer {
		/* refers to a previously opened device */
		integer device_hdl,
		/* opaque value passed back in call-back */
		integer transfer_hdl,
		USB_endpoint endpoint,
		USB_transfer_type ttype,
		octetstring data,
		integer timeout_msec
	};
	/* Response: USB_transfer_compl */

	type record USB_transfer_compl {
		/* refers to a previously opened device */
		integer device_hdl,
		/* opaque value passed back in call-back */
		integer transfer_hdl,
		USB_endpoint endpoint,
		USB_transfer_type ttype,
		octetstring data,
		USB_transfer_status status
	};

	type record USB_result {
		integer req_hdl,
		integer device_hdl,
		integer result_code
	};

	type record USB_open_vid_pid {
		integer req_hdl,
		integer device_hdl,
		USB_vendor_id vendor_id,
		USB_product_id product_id
	};
	/* Response: USB_result */

	type record USB_open_path {
		integer req_hdl,
		integer device_hdl,
		charstring path
	};
	/* Response: USB_result */


	type record USB_set_configuration {
		integer req_hdl,
		integer device_hdl,
		integer configuration
	};
	/* Response: USB_result */

	type record USB_claim_interface {
		integer req_hdl,
		integer device_hdl,
		integer interface
	};
	/* Response: USB_result */

	type record USB_release_interface {
		integer req_hdl,
		integer device_hdl,
		integer interface
	};
	/* Response: USB_result */

	type record USB_get_device_descriptor {
		integer req_hdl,
		integer device_hdl
	};
	/* Response: USB_descriptor */

	type record USB_get_config_descriptor {
		integer req_hdl,
		integer device_hdl,
		integer config_index
	};
	/* Response: USB_descriptor */

	type record USB_get_active_config_descriptor {
		integer req_hdl,
		integer device_hdl
	};
	/* Response: USB_descriptor */

	type record USB_get_config_descriptor_by_value {
		integer req_hdl,
		integer device_hdl,
		integer config_value
	};
	/* Response: USB_descriptor */

	type record USB_get_string_descriptor {
		integer req_hdl,
		integer device_hdl,
		integer index,
		integer language_id
	};
	/* Response: USB_descriptor */

	type record USB_descriptor {
		integer req_hdl,
		integer device_hdl,
		integer result_code,
		octetstring data
	};

	type record USB_reset_device {
		integer req_hdl,
		integer device_hdl
	};
	/* Response: USB_result */

template (value) USB_open_vid_pid
ts_USB_open_vid_pid(USB_vendor_id vid, USB_product_id pid, integer device_hdl := -1,
		    integer req_hdl := -1) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	vendor_id := vid,
	product_id := pid
}

template (value) USB_open_path
ts_USB_open_path(charstring path, integer device_hdl := -1, integer req_hdl := -1) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	path := path
}


template USB_result tr_USB_result(template integer req_hdl := ?, template integer device_hdl := ?,
				  template integer result_code := ?) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	result_code := result_code
}

template (value) USB_claim_interface
ts_USB_claim_interface(integer device_hdl, integer bInterface, integer req_hdl := -1) :=
{
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	interface := bInterface
}

template (value) USB_get_device_descriptor
ts_USB_get_device_descriptor(integer device_hdl, integer req_hdl := -1) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl
}

template (value) USB_get_config_descriptor
ts_USB_get_config_descriptor(integer device_hdl, integer config_index, integer req_hdl := -1) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	config_index := config_index
}

template (value) USB_get_active_config_descriptor
ts_USB_get_active_config_descriptor(integer device_hdl, integer req_hdl := -1) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl
}

template (value) USB_get_config_descriptor_by_value
ts_USB_get_config_descriptor_by_value(integer device_hdl, integer cfg_val, integer req_hdl := -1) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	config_value := cfg_val
}

template (value) USB_set_configuration
ts_USB_set_configuration(integer device_hdl, integer config_num := 1, integer req_hdl := -1) :=
{
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	configuration := config_num
}

template (value) USB_reset_device
ts_USB_reset_device(integer device_hdl, integer req_hdl := -1) :=
{
	req_hdl := req_hdl,
	device_hdl := device_hdl
}

template USB_descriptor
tr_USB_descriptor(template integer device_hdl :=?, template integer req_hdl := ?,
		  template integer result_code := ?, template octetstring data := ?) := {
	req_hdl := req_hdl,
	device_hdl := device_hdl,
	result_code := result_code,
	data := data
}

};