freescale/fman/fman.h

1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0-or-later */
3  * Copyright 2008 - 2015 Freescale Semiconductor Inc.
21 /* TX-Port: Unsupported Format */
29 /* IPR non-consistent-sp */
66 /* non Frame-Manager error */
69 /* FMan driver defines */
77 struct fman; /* FMan data */
107 	FMAN_EX_MURAM_ECC		/* Double bit ECC occurred on MURAM */
119 	__be16 cksum;		/* Running-sum */
120 	/* Flags&fragment-offset field of the last IP-header */
127 	u8 ip_pid_off;		/* IP PID (last IP-proto) offset */
143 	 * buffer; Note that the private-area will start from the base
149 	 * order to get the parser-result from a buffer.
156 	 * parser-result from a buffer.
159 	/* Add all other Internal-Context information: AD,
160 	 * hash-result, key, etc.
166  * buffer pools used by a port or storage-profile.
175  * storage-profile.
194 	 * depletion (Note - this pool must be used by this port!).
198 	 * after a single-pool is depleted;
202 	 * for depletion (Note - this pool must be used by this port!)
207 /* Enum for inter-module interrupts registration */
210 	FMAN_MOD_FMAN_CTRL,	/* FMAN Controller */
220 /* Enum for inter-module interrupts registration */
242 	FMAN_EV_FMAN_CTRL_0,	/* Fman controller event 0 */
243 	FMAN_EV_FMAN_CTRL_1,	/* Fman controller event 1 */
244 	FMAN_EV_FMAN_CTRL_2,	/* Fman controller event 2 */
245 	FMAN_EV_FMAN_CTRL_3,	/* Fman controller event 3 */
255  * fman         - Pointer to FMan
256  * exception    - The exception.
263 typedef irqreturn_t (fman_exceptions_cb)(struct fman *fman,
266  * fman         - Pointer to FMan
267  * port_id      - Port id
268  * addr         - Address that caused the error
269  * tnum         - Owner of error
270  * liodn        - Logical IO device number
277 typedef irqreturn_t (fman_bus_error_cb)(struct fman *fman, u8 port_id,
282 	void __iomem *base_addr;                /* FMan virtual address */
283 	struct resource *res;                   /* FMan memory resource */
284 	u8 id;                                  /* FMan ID */
286 	int err_irq;                            /* FMan Error IRQ */
288 	u16 clk_freq;                           /* FMan clock freq (In Mhz) */
293 	struct resource muram_res;              /* MURAM resource */
296 struct fman {  struct
309 	/* Spinlock for FMan use */
314 	struct muram_info *muram;  member
316 	/* cam section in muram */
319 	/* Fifo in MURAM */
329 /* Structure for port-FM communication during fman_port_init. */
347 void fman_get_revision(struct fman *fman, struct fman_rev_info *rev_info);  argument
349 void fman_register_intr(struct fman *fman, enum fman_event_modules mod,
353 void fman_unregister_intr(struct fman *fman, enum fman_event_modules mod,
356 int fman_set_port_params(struct fman *fman,
359 int fman_reset_mac(struct fman *fman, u8 mac_id);
361 u16 fman_get_clock_freq(struct fman *fman);
363 u32 fman_get_bmi_max_fifo_size(struct fman *fman);
365 int fman_set_mac_max_frame(struct fman *fman, u8 mac_id, u16 mfl);
367 u32 fman_get_qman_channel_id(struct fman *fman, u32 port_id);
369 struct resource *fman_get_mem_region(struct fman *fman);
379 struct fman *fman_bind(struct device *dev);