scic_sds_port_registers.h revision 331722 
1/*-
2 * This file is provided under a dual BSD/GPLv2 license.  When using or
3 * redistributing this file, you may do so under either license.
4 *
5 * GPL LICENSE SUMMARY
6 *
7 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of version 2 of the GNU General Public License as
11 * published by the Free Software Foundation.
12 *
13 * This program is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16 * General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
21 * The full GNU General Public License is included in this distribution
22 * in the file called LICENSE.GPL.
23 *
24 * BSD LICENSE
25 *
26 * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved.
27 * All rights reserved.
28 *
29 * Redistribution and use in source and binary forms, with or without
30 * modification, are permitted provided that the following conditions
31 * are met:
32 *
33 *   * Redistributions of source code must retain the above copyright
34 *     notice, this list of conditions and the following disclaimer.
35 *   * Redistributions in binary form must reproduce the above copyright
36 *     notice, this list of conditions and the following disclaimer in
37 *     the documentation and/or other materials provided with the
38 *     distribution.
39 *
40 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
41 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
42 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
43 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
44 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
45 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
46 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
47 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
48 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
49 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
50 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
51 *
52 * $FreeBSD: stable/11/sys/dev/isci/scil/scic_sds_port_registers.h 331722 2018-03-29 02:50:57Z eadler $
53 */
54#ifndef _SCIC_SDS_PORT_REGISTERS_H_
55#define _SCIC_SDS_PORT_REGISTERS_H_
56
57/**
58 * @file
59 *
60 * @brief This file contains a set of macros that assist in reading the SCU
61 * hardware registers.
62 */
63
64#ifdef __cplusplus
65extern "C" {
66#endif // __cplusplus
67
68/**
69 * Macro to read the port task scheduler register associated with this port
70 * object
71 */
72#define scu_port_task_scheduler_read(port, reg) \
73   scu_register_read( \
74      scic_sds_port_get_controller(port), \
75      (port)->port_task_scheduler_registers->reg \
76   )
77
78/**
79 * Macro to write the port task scheduler register associated with this
80 * port object
81 */
82#define scu_port_task_scheduler_write(port, reg, value) \
83   scu_register_write( \
84      scic_sds_port_get_controller(port), \
85      (port)->port_task_scheduler_registers->reg, \
86      (value) \
87   )
88
89#define scu_port_viit_register_write(port, reg, value) \
90   scu_register_write( \
91      scic_sds_port_get_controller(port), \
92      (port)->viit_registers->reg, \
93      (value) \
94   )
95
96//****************************************************************************
97//* Port Task Scheduler registers controlled by the port object
98//****************************************************************************
99
100/**
101 * Macro to read the port task scheduler control register
102 */
103#define SCU_PTSxCR_READ(port) \
104   scu_port_task_scheduler_read(port, control)
105
106/**
107 * Macro to write the port task scheduler control regsister
108 */
109#define SCU_PTSxCR_WRITE(port, value) \
110   scu_port_task_scheduler_write(port, control, value)
111
112//****************************************************************************
113//* Port PE Configuration registers
114//****************************************************************************
115
116/**
117 * Macro to write the PE Port Configuration Register
118 */
119#define SCU_PCSPExCR_WRITE(port, phy_id, value) \
120   scu_register_write( \
121      scic_sds_port_get_controller(port), \
122      (port)->port_pe_configuration_register[phy_id], \
123      (value) \
124   )
125
126/**
127 * Macro to read the PE Port Configuration Regsiter
128 */
129#define SCU_PCSPExCR_READ(port, phy_id) \
130   scu_register_read( \
131      scic_sds_port_get_controller(port), \
132      (port)->port_pe_configuration_register[phy_id] \
133   )
134
135#ifdef __cplusplus
136}
137#endif // __cplusplus
138
139#endif // _SCIC_SDS_PORT_REGISTERS_H_
140