PHDC Configuration

General Configuration

Class Instance Configuration

Before starting the communication phase, your application needs to initialize and configure the class to suit its needs. Table - PHDC Initialization API Summary summarizes the initialization functions provided by the PHDC implementation. For a complete API reference, see the PHDC Functions reference.

You need to follow these steps to successfully initialize PHDC:

1. Call USBD_PHDC_Init()
   This is the first function you should call, and you should do it only once, even if you use multiple class instances. This function will initialize all internal structures and variables that the class will need. It will also initialize the real-time operating system (RTOS) layer.
2. Call USBD_PHDC_Add()
   This function will allocate a PHDC instance. This call will also let you determine if the PHDC instance is capable of sending / receiving the metadata message preamble and if it uses a vendor-defined or ISO/IEEE-11073 based data and messaging protocol.
   Another parameter of this function lets you specify a callback function that the class will call when the host enables / disables metadata message preambles. This is useful for the application as the behavior in communication will differ depending on the metadata message preamble state.
   If your application needs to send low latency / good reliability data, the class will need to allocate an interrupt endpoint. The endpoint’s interval will be specified in this call as well.

3. Call USBD_PHDC_RdCfg() and USBD_PHDC_WrCfg()
   The next step is to call USBD_PHDC_RdCfg() and USBD_PHDC_WrCfg(). These functions will let you set the latency / reliability bins that the communication pipe will carry. Bins are listed in Table - Listing of QoS Bins. It will also be used to specify opaque data to send within extra endpoint metadata descriptors (see “USB Device Class Definition for Personal Healthcare Devices”, Release 1.0, Section 5 for more details on PHDC extra descriptors).

4. Call USBD_PHDC_11073_ExtCfg() (optional)
   If the PHDC instance uses ISO/IEEE 11073-based data and messaging protocol, a call to this function will let you configure the device specialization code(s).
5. Call USBD_PHDC_CfgAdd()

Finally, once the class instance is correctly configured and initialized, you will need to add it to a USB configuration. This is done by calling USBD_PHDC_CfgAdd().

Listing - PHDC Instance Initialization and Configuration Example shows an example of initialization and configuration of a PHDC instance. If you need more than one class instance of PHDC for your application, refer to the Class Instance Concept page for generic examples of how to build your device.

CPU_BOOLEAN  App_USBD_PHDC_Init(CPU_INT08U  dev_nbr,
                                CPU_INT08U  cfg_hs,
                                CPU_INT08U  cfg_fs) 
{
    USBD_ERR    err;
    CPU_INT08U  class_nbr;
 

    USBD_PHDC_Init(&err);                                                     (1)
    class_nbr = USBD_PHDC_Add(DEF_YES,                                        (2)
                              DEF_YES,
                              App_USBD_PHDC_SetPreambleEn,
                              10,
                             &err);
 
    latency_rely_flags = USBD_PHDC_LATENCY_VERYHIGH_RELY_BEST |
                         USBD_PHDC_LATENCY_HIGH_RELY_BEST     |
                         USBD_PHDC_LATENCY_MEDIUM_RELY_BEST;
    USBD_PHDC_RdCfg(class_nbr,                                                (3)
                    latency_rely_flags,
                    opaque_data_rx,
                    sizeof(opaque_data_rx),
                   &err);
    USBD_PHDC_WrCfg(class_nbr,                                                (3)
                    USBD_PHDC_LATENCY_VERYHIGH_RELY_BEST,
                    opaque_data_tx,
                    sizeof(opaque_data_tx),
                   &err);

    USBD_PHDC_11073_ExtCfg(class_nbr, dev_specialization, 1, &err);           (4)
    valid_cfg_hs = USBD_PHDC_CfgAdd(class_nbr, dev_nbr, cfg_hs, &err);        (5)
    valid_cfg_fs = USBD_PHDC_CfgAdd(class_nbr, dev_nbr, cfg_fs, &err);        (6)
}