USBD_PHDC_Add

Description

Create a new instance of the PHDC.

Files

usbd_phdc.h / usbd_phdc.c

Prototype

CPU_INT08U  USBD_PHDC_Add (CPU_BOOLEAN                    data_fmt_11073,
                           CPU_BOOLEAN                    preamble_capable,
                           USBD_PHDC_PREAMBLE_EN_NOTIFY   preamble_en_notify,
                           CPU_INT16U                     low_latency_interval,
                           USBD_ERR                      *p_err)

Arguments

data_fmt_11073

Variable that indicates whether the class instance uses IEEE 11073 or a vendor-defined data format.

DEF_YES

Class instance uses IEEE 11073 data format.

DEF_NO

Class instance uses vendor-defined data format.

preamble_capable

Variable that indicates whether the class instance support metadata message preamble or not.

DEF_YES

Class instance support metadata message preamble.

DEF_NO

Class instance doesn’t support metadata message preamble.

preamble_en_notify

Pointer to a callback function that will notify the application if the host enable / disable metadata message preamble.

low_latency_interval

Interrupt endpoint interval in milliseconds. Can be 0 if PHDC device will not send low latency data. When the value is different from 0, it must be a power of 2.

p_err

Pointer to variable that will receive the return error code from this function.

USBD_ERR_NONE

USBD_ERR_ALLOC

Returned Value

Class instance number, if NO error(s).

USBD_CLASS_NBR_NONE, otherwise.

Callers

Application.

Notes / Warnings

None.