Neonode zForce(TM) SDK

PlatformDevice.h
Go to the documentation of this file.
1
11 #ifndef DEVICE_PLATFORMDEVICE_PLATFORMDEVICE_H
12 #define DEVICE_PLATFORMDEVICE_PLATFORMDEVICE_H 1
13
14 #ifndef ZFORCECOMMON_H
15 #error Please include "zForceCommon.h" before this file.
16 #endif // ZFORCECOMMON_H
17
23 struct PlatformDevice
24 {
25 zForce * zForce;
26 Connection * Connection;
27 DeviceType DeviceType;
28 uint32_t DeviceIndex;
29 Device ** StorageDevices;
30 uint32_t NumberOfStorageDevices;
31 void * PrivateProtocolData;
43 void ( * Destructor)(Device * self);
56 bool ( * GetFingerFrequency)(PlatformDevice * self);
57
72 bool ( * SetFingerFrequency)(PlatformDevice * self, uint32_t frequency);
73
87 bool ( * GetIdleFrequency)(PlatformDevice * self);
88
103 bool ( * SetIdleFrequency)(PlatformDevice * self, uint32_t frequency);
104
118 bool ( * GetMcuUniqueIdentifier)(PlatformDevice * self);
119
135 bool ( * SetMcuUniqueIdentifier)(PlatformDevice * self, uint8_t * identifier, uint32_t bufferSize);
136 };
137
138 #ifdef __cplusplus
139 extern "C"
140 {
141 #endif // __cplusplus
142
158 DLLINTERNAL PlatformDevice * PlatformDevice_New (Connection * connection, DeviceType deviceType, uint32_t deviceIndex,
159 size_t size);
160
161 #ifdef __cplusplus
162 }
163 #endif // _cplusplus
164
165 #endif // DEVICE_PLATFORMDEVICE_PLATFORMDEVICE_H
166
PlatformDevice_New
DLLINTERNAL PlatformDevice * PlatformDevice_New(Connection *connection, DeviceType deviceType, uint32_t deviceIndex, size_t size)
Internal call used to create a new PlatformDevice.
Connection
The main Connection struct.
Definition: Connection.h:66
Device
Device base class.
Definition: Device.h:26
PlatformDevice
Struct representing a PlatformDevice.
Definition: PlatformDevice.h:24
PlatformDevice::GetFingerFrequency
bool(* GetFingerFrequency)(PlatformDevice *self)
Get the finger frequency.
Definition: PlatformDevice.h:56
PlatformDevice::Connection
Connection * Connection
The Connection this Device is part of.
Definition: PlatformDevice.h:26
PlatformDevice::DeviceIndex
uint32_t DeviceIndex
Which Device Index this device has.
Definition: PlatformDevice.h:28
PlatformDevice::DeviceType
DeviceType DeviceType
Which type of Device this is.
Definition: PlatformDevice.h:27
PlatformDevice::StorageDevices
Device ** StorageDevices
Future: List of Storage Devices. Will change type during implementation.
Definition: PlatformDevice.h:29
PlatformDevice::SetFingerFrequency
bool(* SetFingerFrequency)(PlatformDevice *self, uint32_t frequency)
Set the finger frequency.
Definition: PlatformDevice.h:72
PlatformDevice::zForce
zForce * zForce
Pointer to zForce.
Definition: PlatformDevice.h:25
PlatformDevice::NumberOfStorageDevices
uint32_t NumberOfStorageDevices
Number of Storage Devices.
Definition: PlatformDevice.h:30
PlatformDevice::GetMcuUniqueIdentifier
bool(* GetMcuUniqueIdentifier)(PlatformDevice *self)
Get the Mcu Unique Identifier.
Definition: PlatformDevice.h:118
PlatformDevice::PrivateProtocolData
void * PrivateProtocolData
Private Protocol Data.
Definition: PlatformDevice.h:31
PlatformDevice::SetIdleFrequency
bool(* SetIdleFrequency)(PlatformDevice *self, uint32_t frequency)
Set the idle frequency.
Definition: PlatformDevice.h:103
PlatformDevice::Destructor
void(* Destructor)(Device *self)
Destructor.
Definition: PlatformDevice.h:43
PlatformDevice::SetMcuUniqueIdentifier
bool(* SetMcuUniqueIdentifier)(PlatformDevice *self, uint8_t *identifier, uint32_t bufferSize)
Set the Mcu Unique Identifier.
Definition: PlatformDevice.h:135
PlatformDevice::GetIdleFrequency
bool(* GetIdleFrequency)(PlatformDevice *self)
Get the idle frequency.
Definition: PlatformDevice.h:87
zForce
Main struct.
Definition: zForce.h:29
DeviceType
DeviceType
Enum describing the different device types that exists.
Definition: zForceTypes.h:90