2 * Copyright 2008-2015 Freescale Semiconductor Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Freescale Semiconductor nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
17 * ALTERNATIVELY, this software may be distributed under the terms of the
18 * GNU General Public License ("GPL") as published by the Free Software
19 * Foundation, either version 2 of that License or (at your option) any
22 * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
23 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
24 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25 * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
26 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
27 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
29 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 #include <linux/interrupt.h>
39 #include <linux/of_irq.h>
41 /* FM Frame descriptor macros */
42 /* Frame queue Context Override */
43 #define FM_FD_CMD_FCO 0x80000000
44 #define FM_FD_CMD_RPD 0x40000000 /* Read Prepended Data */
45 #define FM_FD_CMD_DTC 0x10000000 /* Do L4 Checksum */
47 /* TX-Port: Unsupported Format */
48 #define FM_FD_ERR_UNSUPPORTED_FORMAT 0x04000000
49 /* TX Port: Length Error */
50 #define FM_FD_ERR_LENGTH 0x02000000
51 #define FM_FD_ERR_DMA 0x01000000 /* DMA Data error */
53 /* IPR frame (not error) */
54 #define FM_FD_IPR 0x00000001
55 /* IPR non-consistent-sp */
56 #define FM_FD_ERR_IPR_NCSP (0x00100000 | FM_FD_IPR)
58 #define FM_FD_ERR_IPR (0x00200000 | FM_FD_IPR)
60 #define FM_FD_ERR_IPR_TO (0x00300000 | FM_FD_IPR)
61 /* TX Port: Length Error */
62 #define FM_FD_ERR_IPRE (FM_FD_ERR_IPR & ~FM_FD_IPR)
64 /* Rx FIFO overflow, FCS error, code error, running disparity error
65 * (SGMII and TBI modes), FIFO parity error. PHY Sequence error,
66 * PHY error control character detected.
68 #define FM_FD_ERR_PHYSICAL 0x00080000
69 /* Frame too long OR Frame size exceeds max_length_frame */
70 #define FM_FD_ERR_SIZE 0x00040000
71 /* classification discard */
72 #define FM_FD_ERR_CLS_DISCARD 0x00020000
73 /* Extract Out of Frame */
74 #define FM_FD_ERR_EXTRACTION 0x00008000
75 /* No Scheme Selected */
76 #define FM_FD_ERR_NO_SCHEME 0x00004000
77 /* Keysize Overflow */
78 #define FM_FD_ERR_KEYSIZE_OVERFLOW 0x00002000
79 /* Frame color is red */
80 #define FM_FD_ERR_COLOR_RED 0x00000800
81 /* Frame color is yellow */
82 #define FM_FD_ERR_COLOR_YELLOW 0x00000400
83 /* Parser Time out Exceed */
84 #define FM_FD_ERR_PRS_TIMEOUT 0x00000080
85 /* Invalid Soft Parser instruction */
86 #define FM_FD_ERR_PRS_ILL_INSTRUCT 0x00000040
87 /* Header error was identified during parsing */
88 #define FM_FD_ERR_PRS_HDR_ERR 0x00000020
89 /* Frame parsed beyind 256 first bytes */
90 #define FM_FD_ERR_BLOCK_LIMIT_EXCEEDED 0x00000008
92 /* non Frame-Manager error */
93 #define FM_FD_RX_STATUS_ERR_NON_FM 0x00400000
95 /* FMan driver defines */
96 #define FMAN_BMI_FIFO_UNITS 0x100
97 #define OFFSET_UNITS 16
100 #define BM_MAX_NUM_OF_POOLS 64 /* Buffers pools */
101 #define FMAN_PORT_MAX_EXT_POOLS_NUM 8 /* External BM pools per Rx port */
103 struct fman; /* FMan data */
105 /* Enum for defining port types */
106 enum fman_port_type {
107 FMAN_PORT_TYPE_TX = 0, /* TX Port */
108 FMAN_PORT_TYPE_RX, /* RX Port */
111 struct fman_rev_info {
112 u8 major; /* Major revision */
113 u8 minor; /* Minor revision */
116 enum fman_exceptions {
117 FMAN_EX_DMA_BUS_ERROR = 0, /* DMA bus error. */
118 FMAN_EX_DMA_READ_ECC, /* Read Buffer ECC error */
119 FMAN_EX_DMA_SYSTEM_WRITE_ECC, /* Write Buffer ECC err on sys side */
120 FMAN_EX_DMA_FM_WRITE_ECC, /* Write Buffer ECC error on FM side */
121 FMAN_EX_DMA_SINGLE_PORT_ECC, /* Single Port ECC error on FM side */
122 FMAN_EX_FPM_STALL_ON_TASKS, /* Stall of tasks on FPM */
123 FMAN_EX_FPM_SINGLE_ECC, /* Single ECC on FPM. */
124 FMAN_EX_FPM_DOUBLE_ECC, /* Double ECC error on FPM ram access */
125 FMAN_EX_QMI_SINGLE_ECC, /* Single ECC on QMI. */
126 FMAN_EX_QMI_DOUBLE_ECC, /* Double bit ECC occurred on QMI */
127 FMAN_EX_QMI_DEQ_FROM_UNKNOWN_PORTID,/* DeQ from unknown port id */
128 FMAN_EX_BMI_LIST_RAM_ECC, /* Linked List RAM ECC error */
129 FMAN_EX_BMI_STORAGE_PROFILE_ECC,/* storage profile */
130 FMAN_EX_BMI_STATISTICS_RAM_ECC,/* Statistics RAM ECC Err Enable */
131 FMAN_EX_BMI_DISPATCH_RAM_ECC, /* Dispatch RAM ECC Error Enable */
132 FMAN_EX_IRAM_ECC, /* Double bit ECC occurred on IRAM */
133 FMAN_EX_MURAM_ECC /* Double bit ECC occurred on MURAM */
136 /* Parse results memory layout */
137 struct fman_prs_result {
138 u8 lpid; /* Logical port id */
139 u8 shimr; /* Shim header result */
140 __be16 l2r; /* Layer 2 result */
141 __be16 l3r; /* Layer 3 result */
142 u8 l4r; /* Layer 4 result */
143 u8 cplan; /* Classification plan id */
144 __be16 nxthdr; /* Next Header */
145 __be16 cksum; /* Running-sum */
146 /* Flags&fragment-offset field of the last IP-header */
147 __be16 flags_frag_off;
148 /* Routing type field of a IPV6 routing extension header */
150 /* Routing Extension Header Present; last bit is IP valid */
152 u8 shim_off[2]; /* Shim offset */
153 u8 ip_pid_off; /* IP PID (last IP-proto) offset */
154 u8 eth_off; /* ETH offset */
155 u8 llc_snap_off; /* LLC_SNAP offset */
156 u8 vlan_off[2]; /* VLAN offset */
157 u8 etype_off; /* ETYPE offset */
158 u8 pppoe_off; /* PPP offset */
159 u8 mpls_off[2]; /* MPLS offset */
160 u8 ip_off[2]; /* IP offset */
161 u8 gre_off; /* GRE offset */
162 u8 l4_off; /* Layer 4 offset */
163 u8 nxthdr_off; /* Parser end point */
166 /* A structure for defining buffer prefix area content. */
167 struct fman_buffer_prefix_content {
168 /* Number of bytes to be left at the beginning of the external
169 * buffer; Note that the private-area will start from the base
170 * of the buffer address.
173 /* true to pass the parse result to/from the FM;
174 * User may use FM_PORT_GetBufferPrsResult() in
175 * order to get the parser-result from a buffer.
177 bool pass_prs_result;
178 /* true to pass the timeStamp to/from the FM User */
179 bool pass_time_stamp;
180 /* true to pass the KG hash result to/from the FM User may
181 * use FM_PORT_GetBufferHashResult() in order to get the
182 * parser-result from a buffer.
184 bool pass_hash_result;
185 /* Add all other Internal-Context information: AD,
186 * hash-result, key, etc.
191 /* A structure of information about each of the external
192 * buffer pools used by a port or storage-profile.
194 struct fman_ext_pool_params {
195 u8 id; /* External buffer pool id */
196 u16 size; /* External buffer pool buffer size */
199 /* A structure for informing the driver about the external
200 * buffer pools allocated in the BM and used by a port or a
203 struct fman_ext_pools {
204 u8 num_of_pools_used; /* Number of pools use by this port */
205 struct fman_ext_pool_params ext_buf_pool[FMAN_PORT_MAX_EXT_POOLS_NUM];
206 /* Parameters for each port */
209 /* A structure for defining BM pool depletion criteria */
210 struct fman_buf_pool_depletion {
211 /* select mode in which pause frames will be sent after a
212 * number of pools (all together!) are depleted
214 bool pools_grp_mode_enable;
215 /* the number of depleted pools that will invoke pause
216 * frames transmission.
219 /* For each pool, true if it should be considered for
220 * depletion (Note - this pool must be used by this port!).
222 bool pools_to_consider[BM_MAX_NUM_OF_POOLS];
223 /* select mode in which pause frames will be sent
224 * after a single-pool is depleted;
226 bool single_pool_mode_enable;
227 /* For each pool, true if it should be considered
228 * for depletion (Note - this pool must be used by this port!)
230 bool pools_to_consider_for_single_mode[BM_MAX_NUM_OF_POOLS];
233 /* Enum for inter-module interrupts registration */
234 enum fman_event_modules {
235 FMAN_MOD_MAC = 0, /* MAC event */
236 FMAN_MOD_FMAN_CTRL, /* FMAN Controller */
240 /* Enum for interrupts types */
241 enum fman_intr_type {
243 FMAN_INTR_TYPE_NORMAL
246 /* Enum for inter-module interrupts registration */
247 enum fman_inter_module_event {
248 FMAN_EV_ERR_MAC0 = 0, /* MAC 0 error event */
249 FMAN_EV_ERR_MAC1, /* MAC 1 error event */
250 FMAN_EV_ERR_MAC2, /* MAC 2 error event */
251 FMAN_EV_ERR_MAC3, /* MAC 3 error event */
252 FMAN_EV_ERR_MAC4, /* MAC 4 error event */
253 FMAN_EV_ERR_MAC5, /* MAC 5 error event */
254 FMAN_EV_ERR_MAC6, /* MAC 6 error event */
255 FMAN_EV_ERR_MAC7, /* MAC 7 error event */
256 FMAN_EV_ERR_MAC8, /* MAC 8 error event */
257 FMAN_EV_ERR_MAC9, /* MAC 9 error event */
258 FMAN_EV_MAC0, /* MAC 0 event (Magic packet detection) */
259 FMAN_EV_MAC1, /* MAC 1 event (Magic packet detection) */
260 FMAN_EV_MAC2, /* MAC 2 (Magic packet detection) */
261 FMAN_EV_MAC3, /* MAC 3 (Magic packet detection) */
262 FMAN_EV_MAC4, /* MAC 4 (Magic packet detection) */
263 FMAN_EV_MAC5, /* MAC 5 (Magic packet detection) */
264 FMAN_EV_MAC6, /* MAC 6 (Magic packet detection) */
265 FMAN_EV_MAC7, /* MAC 7 (Magic packet detection) */
266 FMAN_EV_MAC8, /* MAC 8 event (Magic packet detection) */
267 FMAN_EV_MAC9, /* MAC 9 event (Magic packet detection) */
268 FMAN_EV_FMAN_CTRL_0, /* Fman controller event 0 */
269 FMAN_EV_FMAN_CTRL_1, /* Fman controller event 1 */
270 FMAN_EV_FMAN_CTRL_2, /* Fman controller event 2 */
271 FMAN_EV_FMAN_CTRL_3, /* Fman controller event 3 */
275 struct fman_intr_src {
276 void (*isr_cb)(void *src_arg);
280 /** fman_exceptions_cb
281 * fman - Pointer to FMan
282 * exception - The exception.
284 * Exceptions user callback routine, will be called upon an exception
285 * passing the exception identification.
289 typedef irqreturn_t (fman_exceptions_cb)(struct fman *fman,
290 enum fman_exceptions exception);
291 /** fman_bus_error_cb
292 * fman - Pointer to FMan
294 * addr - Address that caused the error
295 * tnum - Owner of error
296 * liodn - Logical IO device number
298 * Bus error user callback routine, will be called upon bus error,
299 * passing parameters describing the errors and the owner.
303 typedef irqreturn_t (fman_bus_error_cb)(struct fman *fman, u8 port_id,
304 u64 addr, u8 tnum, u16 liodn);
306 /* Structure that holds information received from device tree */
307 struct fman_dts_params {
308 void __iomem *base_addr; /* FMan virtual address */
309 struct resource *res; /* FMan memory resource */
312 int err_irq; /* FMan Error IRQ */
314 u16 clk_freq; /* FMan clock freq (In Mhz) */
316 u32 qman_channel_base; /* QMan channels base */
317 u32 num_of_qman_channels; /* Number of QMan channels */
319 struct resource muram_res; /* MURAM resource */
324 void __iomem *base_addr;
325 struct fman_intr_src intr_mng[FMAN_EV_CNT];
327 struct fman_fpm_regs __iomem *fpm_regs;
328 struct fman_bmi_regs __iomem *bmi_regs;
329 struct fman_qmi_regs __iomem *qmi_regs;
330 struct fman_dma_regs __iomem *dma_regs;
331 struct fman_hwp_regs __iomem *hwp_regs;
332 struct fman_kg_regs __iomem *kg_regs;
333 fman_exceptions_cb *exception_cb;
334 fman_bus_error_cb *bus_error_cb;
335 /* Spinlock for FMan use */
337 struct fman_state_struct *state;
339 struct fman_cfg *cfg;
340 struct muram_info *muram;
341 struct fman_keygen *keygen;
342 /* cam section in muram */
343 unsigned long cam_offset;
346 unsigned long fifo_offset;
350 u32 liodn_offset[64];
352 struct fman_dts_params dts_params;
355 /* Structure for port-FM communication during fman_port_init. */
356 struct fman_port_init_params {
357 u8 port_id; /* port Id */
358 enum fman_port_type port_type; /* Port type */
359 u16 port_speed; /* Port speed */
360 u16 liodn_offset; /* Port's requested resource */
361 u8 num_of_tasks; /* Port's requested resource */
362 u8 num_of_extra_tasks; /* Port's requested resource */
363 u8 num_of_open_dmas; /* Port's requested resource */
364 u8 num_of_extra_open_dmas; /* Port's requested resource */
365 u32 size_of_fifo; /* Port's requested resource */
366 u32 extra_size_of_fifo; /* Port's requested resource */
367 u8 deq_pipeline_depth; /* Port's requested resource */
368 u16 max_frame_length; /* Port's max frame length. */
370 /* LIODN base for this port, to be used together with LIODN offset. */
373 void fman_get_revision(struct fman *fman, struct fman_rev_info *rev_info);
375 void fman_register_intr(struct fman *fman, enum fman_event_modules mod,
376 u8 mod_id, enum fman_intr_type intr_type,
377 void (*f_isr)(void *h_src_arg), void *h_src_arg);
379 void fman_unregister_intr(struct fman *fman, enum fman_event_modules mod,
380 u8 mod_id, enum fman_intr_type intr_type);
382 int fman_set_port_params(struct fman *fman,
383 struct fman_port_init_params *port_params);
385 int fman_reset_mac(struct fman *fman, u8 mac_id);
387 u16 fman_get_clock_freq(struct fman *fman);
389 u32 fman_get_bmi_max_fifo_size(struct fman *fman);
391 int fman_set_mac_max_frame(struct fman *fman, u8 mac_id, u16 mfl);
393 u32 fman_get_qman_channel_id(struct fman *fman, u32 port_id);
395 struct resource *fman_get_mem_region(struct fman *fman);
397 u16 fman_get_max_frm(void);
399 int fman_get_rx_extra_headroom(void);
401 #ifdef CONFIG_DPAA_ERRATUM_A050385
402 bool fman_has_errata_a050385(void);
405 struct fman *fman_bind(struct device *dev);