blob: 8d3b7a9a98ef007f2c84d1b7234210a12b6172ea (
plain)
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
109
110
111
112
113
114
115
116
117
118
119
120
|
// IBM_PROLOG_BEGIN_TAG
// This is an automatically generated prolog.
//
// $Source: src/usr/pnor/pnordd.H $
//
// IBM CONFIDENTIAL
//
// COPYRIGHT International Business Machines Corp. 2011
//
// p1
//
// Object Code Only (OCO) source materials
// Licensed Internal Code Source Materials
// IBM HostBoot Licensed Internal Code
//
// The source code for this program is not published or other-
// wise divested of its trade secrets, irrespective of what has
// been deposited with the U.S. Copyright Office.
//
// Origin: 30
//
// IBM_PROLOG_END
#ifndef __PNOR_PNORDD_H
#define __PNOR_PNORDD_H
/** @file pnordd.H
* @brief Provides the interfaces to the PNOR Device Driver
*/
namespace PNOR
{
//Not sure if this is the right place for these enums, open to suggestions.
/**
* PNOR Modes
*/
enum lscMode
{
MMRD = 0, /**< Indicates PNOR is in MMRD Mode */
PMWR, /**< Indicates PNOR is in PMWR Mode */
LAST_MODE,
};
/**
* @brief Type definition for PNOR address
*/
typedef uint64_t PNORAddress_t;
//@TODO: comment args
/**
* @brief External interface for setting LSC mode
*/
errlHndl_t setLSCAccessMode(lscMode i_mode);
class PnorDD
{
public:
//@TODO: comment args
/**
* @brief Performs an PNOR Read Operation
*/
errlHndl_t read(void* o_buffer,
size_t& io_buflen,
uint64_t i_address);
//@TODO: comment args
/**
* @brief Performs an PNOR Write Operation
*/
errlHndl_t write(void* i_buffer,
size_t& io_buflen,
uint64_t i_address);
//@TODO: comment args
/**
* @brief Set LSC to desired access mode
*/
errlHndl_t setAccessMode(lscMode i_mode);
protected:
/**
* @brief Constructor
*/
PnorDD();
/**
* @brief Destructor
*/
~PnorDD();
//@TODO: comment args
/**
* Verify Request is in appropriate address range
*
*/
errlHndl_t verifyAddressRange(uint64_t i_address,
size_t& i_length);
private:
/**
* PNOR Mode Flag
*/
lscMode iv_lscMode;
};
}; //end PNOR namespace
#endif
|
