Atmel Software Framework

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
USB Personal Healthcare Device Class (PHDC)

protocol definitions

Data Structures

struct  usb_phdc_classfnct_desc_t
 PHDC Class Function Descriptor. More...
 
struct  usb_phdc_fnctext_desc_t
 PHDC Function Extension Descriptor Note: The wDevSpecializations fields must follow this struct. More...
 
struct  usb_phdc_fnctext_singlespec_desc_t
 PHDC Function Extension Descriptor with single specification. More...
 
struct  usb_phdc_meta_data_1_desc_t
 
struct  usb_phdc_meta_data_desc_t
 PHDC Meta-Data Descriptor Note: The optional meta-data field (0 to 253B) can follow this struct. More...
 
struct  usb_phdc_metadata_msg_1_t
 
struct  usb_phdc_metadata_msg_t
 PHDC Meta-Data Message Note: The optional meta-data field (0 to EPx_size-21) can follow this struct. More...
 
struct  usb_phdc_qos_desc_t
 PHDC QoS Descriptor. More...
 

Macros

#define METADATA_MESSAGE_SIG   {'P','h','d','c','Q','o','S','S','i','g','n','a','t','u','r','e'}
 String use by meta-data message to verify it. More...
 

Enumerations

enum  usb_descriptor_type_phdc {
  USB_DT_PHDC_CLASSFUNCTION = 0x20,
  USB_DT_PHDC_QOS = 0x21,
  USB_DT_PHDC_METADATA = 0x22,
  USB_DT_PHDC_11073PHD_FUNCTION = 0x30
}
 PHDC USB descriptor types. More...
 
enum  usb_phdc_capability { USB_PHDC_CAPABILITY_METADATAMSG_PREAMBLE = (1 << 0) }
 PHDC interface capability. More...
 
enum  usb_phdc_data_msg_format_code {
  USB_PHDC_DATAMSG_FORMAT_VENDOR = 0x01,
  USB_PHDC_DATAMSG_FORMAT_11073_20601 = 0x02
}
 PHDC Data/Messaging format code. More...
 
enum  usb_phdc_feature { USB_PHDC_FEATURE_METADATA = 0x01 }
 Standard USB PHDC interface feature flags. More...
 
enum  usb_phdc_qos_encoding_version { USB_PHDC_QOS_ENCODING_VERSION_1 = 0x01 }
 QoS Encoding Version. More...
 

Possible Class value

#define PHDC_CLASS   0x0F
 

Possible SubClass value

#define PHDC_SUB_CLASS   0x00
 

Possible protocol value

Note
Only the BULK protocol should be used in new designs.
#define PHDC_PROTOCOL   0x00
 

latency/reliability bin for the QoS data

#define USB_PHDC_QOS_VERYHIGH_BEST   (1<<5)
 
#define USB_PHDC_QOS_HIGH_BEST   (1<<4)
 
#define USB_PHDC_QOS_MEDIUM_BEST   (1<<3)
 
#define USB_PHDC_QOS_MEDIUM_BETTER   (1<<2)
 
#define USB_PHDC_QOS_MEDIUM_GOOD   (1<<1)
 
#define USB_PHDC_QOS_LOW_GOOD   (1<<0)
 

#define METADATA_MESSAGE_SIG   {'P','h','d','c','Q','o','S','S','i','g','n','a','t','u','r','e'}

String use by meta-data message to verify it.

Referenced by udi_phdc_enable(), and udi_phdc_received_preample().

#define PHDC_CLASS   0x0F
#define PHDC_PROTOCOL   0x00
#define PHDC_SUB_CLASS   0x00
#define USB_PHDC_QOS_HIGH_BEST   (1<<4)
#define USB_PHDC_QOS_MEDIUM_BEST   (1<<3)
#define USB_PHDC_QOS_MEDIUM_BETTER   (1<<2)
#define USB_PHDC_QOS_MEDIUM_GOOD   (1<<1)
#define USB_PHDC_QOS_VERYHIGH_BEST   (1<<5)

PHDC USB descriptor types.

Enumerator
USB_DT_PHDC_CLASSFUNCTION 
USB_DT_PHDC_QOS 
USB_DT_PHDC_METADATA 
USB_DT_PHDC_11073PHD_FUNCTION 

PHDC interface capability.

Enumerator
USB_PHDC_CAPABILITY_METADATAMSG_PREAMBLE 

If Meta_Data Message Preamble is implemented.

PHDC Data/Messaging format code.

Enumerator
USB_PHDC_DATAMSG_FORMAT_VENDOR 
USB_PHDC_DATAMSG_FORMAT_11073_20601 

refer to the section ISO/IEEE AA073-20601 protocol for further information

Standard USB PHDC interface feature flags.

Note
valid for SetFeature and ClearFeature requests.
Enumerator
USB_PHDC_FEATURE_METADATA 

QoS Encoding Version.

Enumerator
USB_PHDC_QOS_ENCODING_VERSION_1