Jim Carver / Mbed OS mbed-cloud-workshop-connect-PIR

Simulated product dispenser

Dependencies:   HTS221

Fork of mbed-cloud-workshop-connect-HTS221 by Jim Carver

Embed: (wiki syntax)

« Back to documentation index

_ARM_PAL_DEVICE_IDENTITY Struct Reference
Data Fields

_ARM_PAL_DEVICE_IDENTITY Struct Reference

Structure definition holding API function pointers. More...

#include <pal_device_identity.h>

Data Fields

arm_uc_error_t(* SetVendorGuid )(const arm_uc_guid_t *vendor_guid)
 Function for setting the vendor GUID.
arm_uc_error_t(* GetVendorGuid )(arm_uc_guid_t *vendor_guid)
 Function for getting a pointer to the vendor GUID.
arm_uc_error_t(* SetClassGuid )(const arm_uc_guid_t *class_guid)
 Function for setting the device class GUID.
arm_uc_error_t(* GetClassGuid )(arm_uc_guid_t *class_guid)
 Function for getting a pointer to the device class GUID.
arm_uc_error_t(* SetDeviceGuid )(const arm_uc_guid_t *device_guid)
 Function for setting the device GUID.
arm_uc_error_t(* GetDeviceGuid )(arm_uc_guid_t *device_guid)
 Function for getting a pointer to the device GUID.
arm_uc_error_t(* DeviceIdentityCheck )(const arm_uc_buffer_t *vendor_guid, const arm_uc_buffer_t *class_guid, const arm_uc_buffer_t *device_guid)
 Check whether the three GUIDs provided are valid on the device.

Detailed Description

Structure definition holding API function pointers.

Definition at line 91 of file pal_device_identity.h.

Field Documentation

arm_uc_error_t(* DeviceIdentityCheck)(const arm_uc_buffer_t *vendor_guid, const arm_uc_buffer_t *class_guid, const arm_uc_buffer_t *device_guid)

Check whether the three GUIDs provided are valid on the device.

Parameters:
vendor_guidBuffer pointer to the Vendor GUID.
class_guidBuffer pointer to the device class GUID.
device_guidBuffer pointer to the device GUID.
Returns:
Error code.

Definition at line 145 of file pal_device_identity.h.

arm_uc_error_t(* GetClassGuid)(arm_uc_guid_t *class_guid)

Function for getting a pointer to the device class GUID.

Parameters:
class_guidPointer to a arm_uc_guid_t pointer.
Returns:
Error code.

Definition at line 120 of file pal_device_identity.h.

arm_uc_error_t(* GetDeviceGuid)(arm_uc_guid_t *device_guid)

Function for getting a pointer to the device GUID.

Parameters:
device_guidPointer to a arm_uc_guid_t pointer.
Returns:
Error code.

Definition at line 135 of file pal_device_identity.h.

arm_uc_error_t(* GetVendorGuid)(arm_uc_guid_t *vendor_guid)

Function for getting a pointer to the vendor GUID.

Parameters:
vendor_guidPointer to a arm_uc_guid_t pointer.
Returns:
Error code.

Definition at line 105 of file pal_device_identity.h.

arm_uc_error_t(* SetClassGuid)(const arm_uc_guid_t *class_guid)

Function for setting the device class GUID.

The GUID is copied.

Parameters:
class_guidPointer to a arm_uc_guid_t GUID.
Returns:
Error code.

Definition at line 113 of file pal_device_identity.h.

arm_uc_error_t(* SetDeviceGuid)(const arm_uc_guid_t *device_guid)

Function for setting the device GUID.

The GUID is copied.

Parameters:
device_guidPointer to a arm_uc_guid_t GUID.
Returns:
Error code.

Definition at line 128 of file pal_device_identity.h.

arm_uc_error_t(* SetVendorGuid)(const arm_uc_guid_t *vendor_guid)

Function for setting the vendor GUID.

The GUID is copied.

Parameters:
vendor_guidPointer to a arm_uc_guid_t GUID.
Returns:
Error code.

Definition at line 98 of file pal_device_identity.h.

Generated on Tue Jul 12 2022 19:12:19 by  doxygen 1.7.2