1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/** @file userif.H
* @brief Provides the user application interfaces for performing device
* access.
*
* @note These interfaces should not be used directly by device drivers.
* Use driverif.H instead.
*/
#ifndef __DEVICEFW_USERIF
#define __DEVICEFW_USERIF
#include <stdint.h>
namespace DeviceFW
{
/* TODO: Update these to real error log / target handle type once those
* pieces of code are complete. */
typedef void* ErrorHandle_t;
typedef int TargetHandle_t;
/** @enum AccessType
* @brief Access types for accessing a hardware device.
*/
enum AccessType
{
SCOM = 0,
PNOR,
MAILBOX,
PRESENT,
LAST_ACCESS_TYPE,
};
/** Construct the device addressing parameters for SCOM device ops.
* @param[in] i_address - Scom address to operate on.
*/
#define DEVICE_SCOM_ADDRESS(i_address) \
DeviceFW::SCOM, static_cast<uint64_t>((i_address))
/** Construct the device addressing parameters for the PRESENT device ops.
*/
#define DEVICE_PRESENT_ADDRESS() \
DeviceFW::PRESENT
/**
* @brief Perform a hardware read operation.
*
* @param[in] i_target Device target to operate on.
* @param[out] o_buffer Buffer to put result data into.
* @param[in,out] io_buflen Length of the buffer on input, length of
* data on output (in bytes).
* @param[in] i_accessType Operation to perform on target.
* @param[in] ... Operation specific addressing parameters.
*
* @return NULL - No error.
* @return Non-NULL - An error handle when error has occured, typically
* passed directly from device driver but potentially
* created by the device framework as in the case of
* not finding an installed driver for the desired
* operation.
*
* It is expected that the callers will use operation specific macros to
* assist in the AccessType parameter and variable arguments.
*
* <PRE>
* Example usage:
* errl = deviceRead(chip, buf, bufsize, DEVICE_SCOM_ADDRESS(0x42));
* </PRE>
*
*/
ErrorHandle_t deviceRead(TargetHandle_t i_target,
void* o_buffer, size_t& io_buflen,
AccessType i_accessType, ...);
/**
* @brief Perform a hardware write operation.
*
* @param[in] i_target Device target to operate on.
* @param[in] i_buffer Buffer to get write data from.
* @param[in,out] io_buflen Length of the buffer on input, length of
* data on output (in bytes).
* @param[in] i_accessType Operation to perform on target.
* @param[in] ... Operation specific addressing parameters.
*
* @return NULL - No error.
* @return Non-NULL - An error handle when error has occured, typically
* passed directly from device driver but potentially
* created by the device framework as in the case of
* not finding an installed driver for the desired
* operation.
*
* It is expected that the callers will use operation specific macros to
* assist in the AccessType parameter and variable arguments.
*
* <PRE>
* Example usage:
* errl = deviceWrite(chip, buf, bufsize, DEVICE_SCOM_ADDRESS(0x42));
* </PRE>
*
*/
ErrorHandle_t deviceWrite(TargetHandle_t i_target,
void* i_buffer, size_t& io_buflen,
AccessType i_accessType, ...);
};
#endif
|
