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
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/mbox/mboxdd.H $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2012,2014 */
/* [+] International Business Machines Corp. */
/* */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); */
/* you may not use this file except in compliance with the License. */
/* You may obtain a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or */
/* implied. See the License for the specific language governing */
/* permissions and limitations under the License. */
/* */
/* IBM_PROLOG_END_TAG */
#ifndef __MBOX_MBOXDD_H
#define __MBOX_MBOXDD_H
#include <errl/errlentry.H>
#include <usr/devicefw/driverif.H>
/** @file mboxdd.H
* @brief Provides the interfaces to the MBOX Device Driver
*/
namespace MBOX
{
/*
* Mbox device driver public constants
*/
enum
{
MBOX_MAX_DATA_BYTES = 64, //16 32-bit Data Registers
};
/*
* Mbox device driver status values
*/
enum MboxReadStatus
{
MBOX_DOORBELL_ERROR = 0x00000004, /* Error Set In Error Register */
MBOX_HW_ACK = 0x00000002, /* LBUS Data Acknowledgment */
MBOX_DATA_PENDING = 0x00000001, /* PIB Data Pending */
MBOX_ILLEGAL_OP = 0x08000000, /* Illegal Operation Attempted */
MBOX_DATA_WRITE_ERR = 0x04000000, /* Write Full LBUS Mailbox Error */
MBOX_DATA_READ_ERR = 0x02000000, /* Read Empty LBUS Mailbox Error */
MBOX_PARITY_ERR = 0x01000000, /* LBUS RAM Parity Error Detected */
};
/**
* @brief Initialize device driver hardware
*
* @param[in] i_target, Chip target of the MBOX operation
* @return errlHndl_t If scom error | NULL (success)
*/
errlHndl_t mboxInit(TARGETING::Target* i_target);
/**
* @brief Disable the reporting of interrupts
* @param[in] i_target, Chip target of the MBOX operations
*/
errlHndl_t mboxddMaskInterrupts(TARGETING::Target * i_target);
/**
* @brief Enable the reporting of interrupts
* @param[in] i_target, Chip target of the MBOX operations
*/
errlHndl_t mboxddEnableInterrupts(TARGETING::Target * i_target);
/**
* @brief Shutdown device driver
*
* @param[in] i_target, Chip target of the MBOX operation
* @return errlHndl_t if scom error | NULL (success)
*/
errlHndl_t mboxddShutDown(TARGETING::Target* i_target);
/**
* @brief Performs a mailbox read operation
*
* @param[in] i_target - Chip target of MBOX operation
* @param[out] o_buffer - Destination buffer for data
* @param[in/out] io_buflen - Size of buffer
* @param[out] o_status - Contains any error status bits
*
* @return errlHndl_t NULL on success
*/
errlHndl_t mboxRead(TARGETING::Target* i_target,
void* o_buffer,
size_t& io_buflen,
uint64_t* o_status);
/**
* @brief Performs a mailbox write operation
*
* @param[in] i_target - Chip target of MBOX operation
* @param[in] i_buffer - Location of data to be written
* @param[in] i_buflen - Size of data
*
* @return errlHndl_t NULL on success
*/
errlHndl_t mboxWrite(TARGETING::Target* i_target,
void* i_buffer,
size_t& i_buflen);
/**
* @brief Reads the mailbox PIB error status register
*
* @param[in] i_target - Chip target of MBOX operation
* @param[out] o_status - Bits set to errors found
*/
errlHndl_t mboxGetErrStat(TARGETING::Target* i_target,
uint64_t &o_status);
#if defined(__DESTRUCTIVE_MBOX_TEST__)
void forceErrorOnNextOperation();
#endif
//Mailbox 1 Status & Interrupt register addresses
enum MboxRegs {
MBOX_DB_STAT_CNTRL_1 = 0x00050020, //LBUS(rw),PIB(rw) Stat/Cntrl 1
MBOX_DB_ERR_STAT_PIB = 0x00050031, //LBUS(ro),PIB(rw) Err Stat B
MBOX_DB_ERR_STAT_LBUS = 0x00050030, //LBUS(rw),PIB(ro) Err Stat A
MBOX_DB_INT_REG_LBUS = 0x00050035, //LBUS(rw),PIB(ro) Int Reg A
MBOX_DB_INT_MASK_LBUS_RS = 0x00050036, //LBUS(r/set),PIB(ro) Int Mask A
MBOX_DB_INT_MASK_LBUS_RC = 0x00050037, //LBUS(r/clear),PIB(ro/zero)
MBOX_DB_INT_REG_PIB = 0x00050032, //LBUS(ro),PIB(rw) Int Reg B
MBOX_DB_INT_MASK_PIB_RS = 0x00050033, //LBUS(ro),PIB(r/set) Int Mask B
MBOX_DB_INT_MASK_PIB_RC = 0x00050034, //LBUS(ro/zero,PIB(r/clear)
};
//Mailbox 1 Header/Command register addresses
enum MboxHeadCmdRegs {
MBOX_HEAD_CMD_LBUS0 = 0x00050025, //LBUS(rw),PIB(ro) H/C 0A
MBOX_HEAD_CMD_LBUS1 = 0x00050026, //LBUS(rw),PIB(ro) H/C 1A
MBOX_HEAD_CMD_LBUS2 = 0x00050027, //LBUS(rw),PIB(ro) H/C 2A
MBOX_HEAD_CMD_PIB0 = 0x00050021, //LBUS(ro),PIB(rw) H/C 0B
MBOX_HEAD_CMD_PIB1 = 0x00050022, //LBUS(ro),PIB(rw) H/C 1B
MBOX_HEAD_CMD_PIB2 = 0x00050023, //LBUS(ro),PIB(rw) H/C 2B
};
//Mailbox 1 Data register address boundaries
enum MboxDataRegs {
MBOX_DATA_LBUS_START = 0x00050080, //LBUS(rw),PIB(ro) First address
MBOX_DATA_LBUS_END = 0x0005008F, //LBUS(rw),PIB(ro) Last address
MBOX_DATA_PIB_START = 0x00050040, //LBUS(ro),PIB(rw) First address
MBOX_DATA_PIB_END = 0x0005004F, //LBUS(ro),PIB(rw) Last address
};
// DB_STATUS_1A_REG: doorbell status and control 1a bit masks
enum MboxDBStausReg1a {
MBOX_PERM_TO_SND = 0x80000000, //Permission to Send Doorbell
MBOX_ABORT = 0x40000000, //Abort Doorbell 1
MBOX_LBUS_SLAVE_B_PND = 0x20000000, //Lbus save B pending
// Doorbell 1
MBOX_PIB_SLAVE_A_PND = 0x10000000, //PIB Slave A Pending
// DoorBell 1
// bit 27 - reserved
MBOX_XDN = 0x04000000, //Xdn Doorbell 1
MBOX_XUP = 0x02000000, //Xup Doorbell 1
// bit 24 - reserved
MBOX_HDR_PIB_SLAVE_A = 0x00F00000, // Header Count PIB Slave A
// Doorbell 1
MBOX_DATA_PIB_SLAVE_A = 0x000FF000, // Data Count PIB Slave A
// Doorbell 1
MBOX_HDR_LBUS_SLAVE_B = 0x00000F00, // Header Count LBUS Slave B
// Doorbell 1
MBOX_DATA_LBUS_SLAVE_B =0x000000FF, // Data Count LBUS Slave B
}; // Doorbell 1
}; // namespace MBOX
#endif
|
