summaryrefslogtreecommitdiffstats
path: root/drivers/scsi/isci/core/scic_sds_port_registers.h
blob: cf8bc073b9527b585887a28109f22e15e7d9f39d (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
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*
 * This file is provided under a dual BSD/GPLv2 license.  When using or
 * redistributing this file, you may do so under either license.
 *
 * GPL LICENSE SUMMARY
 *
 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 * The full GNU General Public License is included in this distribution
 * in the file called LICENSE.GPL.
 *
 * BSD LICENSE
 *
 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _SCIC_SDS_PORT_REGISTERS_H_
#define _SCIC_SDS_PORT_REGISTERS_H_

/**
 * This file contains a set of macros that assist in reading the SCU hardware
 *    registers.
 *
 *
 */

/**
 * scu_transport_layer_read() -
 *
 * Macro to read the transport layer register associated with this port object.
 */
#define scu_transport_layer_read(port, reg) \
	scu_register_read(\
		scic_sds_port_get_controller(port), \
		(port)->transport_layer_registers->reg \
		)

/**
 * scu_transport_layer_write() -
 *
 * Macro to write the transport layer register associated with this port object.
 */
#define scu_transport_layer_write(port, reg, value) \
	scu_register_write(\
		scic_sds_port_get_controller(port), \
		(port)->transport_layer_registers->reg,	\
		(value)	\
		)

/**
 * scu_port_task_scheduler_read() -
 *
 * Macro to read the port task scheduler register associated with this port
 * object
 */
#define scu_port_task_scheduler_read(port, reg)	\
	scu_register_read(\
		scic_sds_port_get_controller(port), \
		(port)->port_task_scheduler_registers->reg \
		)

/**
 * scu_port_task_scheduler_write() -
 *
 * Macro to write the port task scheduler register associated with this port
 * object
 */
#define scu_port_task_scheduler_write(port, reg, value)	\
	scu_register_write(\
		scic_sds_port_get_controller(port), \
		(port)->port_task_scheduler_registers->reg, \
		(value)	\
		)

#define scu_port_viit_register_write(port, reg, value) \
	scu_register_write(\
		scic_sds_port_get_controller(port), \
		(port)->viit_registers->reg, \
		(value)	\
		)

/*
 * ****************************************************************************
 * * Transport Layer registers controlled by the port object
 * **************************************************************************** */

/**
 * SCU_TLCR_READ() -
 *
 * This macro reads the Transport layer control register
 */
#define SCU_TLCR_READ(port) \
	scu_transport_layer_read(port, control)

/**
 * SCU_TLCR_WRITE() -
 *
 * This macro writes the Transport layer control register
 */
#define SCU_TLCR_WRITE(port, value) \
	scu_transport_layer_write(port, control, value)

/**
 * SCU_TLADTR_READ() -
 *
 * This macro reads the Transport layer address translation register
 */
#define SCU_TLADTR_READ(port) \
	scu_transport_layer_read(port, address_translation)

/**
 * SCU_TLADTR_WRITE() -
 *
 * This macro writes the Transport layer address translation register
 */
#define SCU_TLADTR_WRITE(port) \
	scu_transport_layer_write(port, address_translation, value)

/**
 * SCU_STPTLDARNI_WRITE() -
 *
 * This macro writes the STP Transport Layer Direct Attached RNi register.
 */
#define SCU_STPTLDARNI_WRITE(port, index) \
	scu_transport_layer_write(port, stp_rni, index)

/**
 * SCU_STPTLDARNI_READ() -
 *
 * This macro reads the STP Transport Layer Direct Attached RNi register.
 */
#define SCU_STPTLDARNI_READ(port) \
	scu_transport_layer_read(port, stp_rni)

/*
 * ****************************************************************************
 * * Port Task Scheduler registers controlled by the port object
 * **************************************************************************** */

/**
 * SCU_PTSxCR_READ() -
 *
 * Macro to read the port task scheduler control register
 */
#define SCU_PTSxCR_READ(port) \
	scu_port_task_scheduler_read(port, control)

/**
 * SCU_PTSxCR_WRITE() -
 *
 * Macro to write the port task scheduler control regsister
 */
#define SCU_PTSxCR_WRITE(port, value) \
	scu_port_task_scheduler_write(port, control, value)

/*
 * ****************************************************************************
 * * Port PE Configuration registers
 * **************************************************************************** */

/**
 * SCU_PCSPExCR_WRITE() -
 *
 * Macro to write the PE Port Configuration Register
 */
#define SCU_PCSPExCR_WRITE(port, phy_id, value)	\
	scu_register_write(\
		scic_sds_port_get_controller(port), \
		(port)->port_pe_configuration_register[phy_id],	\
		(value)	\
		)

/**
 * SCU_PCSPExCR_READ() -
 *
 * Macro to read the PE Port Configuration Regsiter
 */
#define SCU_PCSPExCR_READ(port, phy_id)	\
	scu_register_read(\
		scic_sds_port_get_controller(port), \
		(port)->port_pe_configuration_register[phy_id] \
		)

#endif /* _SCIC_SDS_PORT_REGISTERS_H_ */