2 * Copyright (C) 2013 Realtek Semiconductor Corp.
5 * Unless you and Realtek execute a separate written software license
6 * agreement governing use of this software, this software is licensed
7 * to you under the terms of the GNU General Public License version 2,
8 * available at https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
10 * Purpose : RTL8367/RTL8367C switch high-level API
12 * Feature : The file includes Interrupt module high-layer API definition
16 #ifndef __RTK_API_INTERRUPT_H__
17 #define __RTK_API_INTERRUPT_H__
21 * Data Type Declaration
23 #define RTK_MAX_NUM_OF_INTERRUPT_TYPE 1
26 typedef struct rtk_int_status_s
28 rtk_uint16 value
[RTK_MAX_NUM_OF_INTERRUPT_TYPE
];
31 typedef struct rtk_int_info_s
33 rtk_portmask_t portMask
;
35 rtk_uint32 systemLearnOver
;
38 typedef enum rtk_int_type_e
40 INT_TYPE_LINK_STATUS
= 0,
41 INT_TYPE_METER_EXCEED
,
45 INT_TYPE_GREEN_FEATURE
,
50 INT_TYPE_RESERVED
, /* Unused */
55 typedef enum rtk_int_advType_e
57 ADV_L2_LEARN_PORT_MASK
= 0,
58 ADV_SPEED_CHANGE_PORT_MASK
,
59 ADV_SPECIAL_CONGESTION_PORT_MASK
,
60 ADV_PORT_LINKDOWN_PORT_MASK
,
61 ADV_PORT_LINKUP_PORT_MASK
,
62 ADV_METER_EXCEED_MASK
,
68 typedef enum rtk_int_polarity_e
76 * rtk_int_polarity_set
78 * Set interrupt polarity configuration.
80 * type - Interruptpolarity type.
85 * RT_ERR_FAILED - Failed
86 * RT_ERR_SMI - SMI access error
87 * RT_ERR_INPUT - Invalid input parameters.
89 * The API can set interrupt polarity configuration.
91 extern rtk_api_ret_t
rtk_int_polarity_set(rtk_int_polarity_t type
);
94 * rtk_int_polarity_get
96 * Get interrupt polarity configuration.
100 * pType - Interruptpolarity type.
103 * RT_ERR_FAILED - Failed
104 * RT_ERR_SMI - SMI access error
106 * The API can get interrupt polarity configuration.
108 extern rtk_api_ret_t
rtk_int_polarity_get(rtk_int_polarity_t
*pType
);
111 * rtk_int_control_set
113 * Set interrupt trigger status configuration.
115 * type - Interrupt type.
116 * enable - Interrupt status.
121 * RT_ERR_FAILED - Failed
122 * RT_ERR_SMI - SMI access error
123 * RT_ERR_INPUT - Invalid input parameters.
124 * RT_ERR_ENABLE - Invalid enable input.
126 * The API can set interrupt status configuration.
127 * The interrupt trigger status is shown in the following:
128 * - INT_TYPE_LINK_STATUS
129 * - INT_TYPE_METER_EXCEED
130 * - INT_TYPE_LEARN_LIMIT
131 * - INT_TYPE_LINK_SPEED
133 * - INT_TYPE_GREEN_FEATURE
134 * - INT_TYPE_LOOP_DETECT
136 * - INT_TYPE_CABLE_DIAG,
140 extern rtk_api_ret_t
rtk_int_control_set(rtk_int_type_t type
, rtk_enable_t enable
);
143 * rtk_int_control_get
145 * Get interrupt trigger status configuration.
147 * type - Interrupt type.
149 * pEnable - Interrupt status.
152 * RT_ERR_FAILED - Failed
153 * RT_ERR_SMI - SMI access error
154 * RT_ERR_INPUT - Invalid input parameters.
156 * The API can get interrupt status configuration.
157 * The interrupt trigger status is shown in the following:
158 * - INT_TYPE_LINK_STATUS
159 * - INT_TYPE_METER_EXCEED
160 * - INT_TYPE_LEARN_LIMIT
161 * - INT_TYPE_LINK_SPEED
163 * - INT_TYPE_GREEN_FEATURE
164 * - INT_TYPE_LOOP_DETECT
166 * - INT_TYPE_CABLE_DIAG,
170 extern rtk_api_ret_t
rtk_int_control_get(rtk_int_type_t type
, rtk_enable_t
* pEnable
);
175 * Set interrupt trigger status to clean.
179 * pStatusMask - Interrupt status bit mask.
182 * RT_ERR_FAILED - Failed
183 * RT_ERR_SMI - SMI access error
184 * RT_ERR_INPUT - Invalid input parameters.
186 * The API can clean interrupt trigger status when interrupt happened.
187 * The interrupt trigger status is shown in the following:
188 * - INT_TYPE_LINK_STATUS (value[0] (Bit0))
189 * - INT_TYPE_METER_EXCEED (value[0] (Bit1))
190 * - INT_TYPE_LEARN_LIMIT (value[0] (Bit2))
191 * - INT_TYPE_LINK_SPEED (value[0] (Bit3))
192 * - INT_TYPE_CONGEST (value[0] (Bit4))
193 * - INT_TYPE_GREEN_FEATURE (value[0] (Bit5))
194 * - INT_TYPE_LOOP_DETECT (value[0] (Bit6))
195 * - INT_TYPE_8051 (value[0] (Bit7))
196 * - INT_TYPE_CABLE_DIAG (value[0] (Bit8))
197 * - INT_TYPE_ACL (value[0] (Bit9))
198 * - INT_TYPE_SLIENT (value[0] (Bit11))
199 * The status will be cleared after execute this API.
201 extern rtk_api_ret_t
rtk_int_status_set(rtk_int_status_t
*pStatusMask
);
206 * Get interrupt trigger status.
210 * pStatusMask - Interrupt status bit mask.
213 * RT_ERR_FAILED - Failed
214 * RT_ERR_SMI - SMI access error
215 * RT_ERR_INPUT - Invalid input parameters.
217 * The API can get interrupt trigger status when interrupt happened.
218 * The interrupt trigger status is shown in the following:
219 * - INT_TYPE_LINK_STATUS (value[0] (Bit0))
220 * - INT_TYPE_METER_EXCEED (value[0] (Bit1))
221 * - INT_TYPE_LEARN_LIMIT (value[0] (Bit2))
222 * - INT_TYPE_LINK_SPEED (value[0] (Bit3))
223 * - INT_TYPE_CONGEST (value[0] (Bit4))
224 * - INT_TYPE_GREEN_FEATURE (value[0] (Bit5))
225 * - INT_TYPE_LOOP_DETECT (value[0] (Bit6))
226 * - INT_TYPE_8051 (value[0] (Bit7))
227 * - INT_TYPE_CABLE_DIAG (value[0] (Bit8))
228 * - INT_TYPE_ACL (value[0] (Bit9))
229 * - INT_TYPE_SLIENT (value[0] (Bit11))
232 extern rtk_api_ret_t
rtk_int_status_get(rtk_int_status_t
* pStatusMask
);
235 * rtk_int_advanceInfo_get
237 * Get interrupt advanced information.
239 * adv_type - Advanced interrupt type.
241 * info - Information per type.
244 * RT_ERR_FAILED - Failed
245 * RT_ERR_SMI - SMI access error
246 * RT_ERR_INPUT - Invalid input parameters.
248 * This API can get advanced information when interrupt happened.
249 * The status will be cleared after execute this API.
251 extern rtk_api_ret_t
rtk_int_advanceInfo_get(rtk_int_advType_t adv_type
, rtk_int_info_t
* info
);
254 #endif /* __RTK_API_INTERRUPT_H__ */