xref: /freebsd/sys/arm/ti/cpsw/if_cpswvar.h (revision 4232f826683298e85d469c0ef17259cecd13b2c7)
1 /*-
2  * Copyright (c) 2012 Damjan Marion <dmarion@Freebsd.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef	_IF_CPSWVAR_H
30 #define	_IF_CPSWVAR_H
31 
32 #define CPSW_INTR_COUNT		4
33 
34 /* MII BUS  */
35 #define CPSW_MIIBUS_RETRIES	5
36 #define CPSW_MIIBUS_DELAY	1000
37 
38 #define CPSW_MAX_ALE_ENTRIES	1024
39 
40 #define CPSW_SYSCTL_COUNT 34
41 
42 struct cpsw_slot {
43 	uint32_t bd_offset;  /* Offset of corresponding BD within CPPI RAM. */
44 	bus_dmamap_t dmamap;
45 	struct mbuf *mbuf;
46 	STAILQ_ENTRY(cpsw_slot) next;
47 };
48 STAILQ_HEAD(cpsw_slots, cpsw_slot);
49 
50 struct cpsw_queue {
51 	struct mtx	lock;
52 	int		running;
53 	struct cpsw_slots active;
54 	struct cpsw_slots avail;
55 	uint32_t	queue_adds; /* total bufs added */
56 	uint32_t	queue_removes; /* total bufs removed */
57 	uint32_t	queue_removes_at_last_tick; /* Used by watchdog */
58 	int		queue_slots;
59 	int		active_queue_len;
60 	int		max_active_queue_len;
61 	int		avail_queue_len;
62 	int		max_avail_queue_len;
63 	int		longest_chain; /* Largest # segments in a single packet. */
64 	int		hdp_offset;
65 };
66 
67 struct cpsw_softc {
68 	struct ifnet	*ifp;
69 	phandle_t	node;
70 	device_t	dev;
71 	struct bintime	attach_uptime; /* system uptime when attach happened. */
72 	struct bintime	init_uptime; /* system uptime when init happened. */
73 
74 	/* TODO: We should set up a child structure for each port;
75 	   store mac, phy information, etc, in that structure. */
76 	uint8_t		mac_addr[ETHER_ADDR_LEN];
77 
78 	device_t	miibus;
79 	struct mii_data	*mii;
80 	/* We expect 1 memory resource and 4 interrupts from the device tree. */
81 	struct resource	*mem_res;
82 	int		mem_rid;
83 	struct resource	*irq_res[CPSW_INTR_COUNT];
84 
85 	/* Interrupts get recorded here as we initialize them. */
86 	/* Interrupt teardown just walks this list. */
87 	struct {
88 		struct resource *res;
89 		void		*ih_cookie;
90 		const char *description;
91 	} interrupts[CPSW_INTR_COUNT];
92 	int		interrupt_count;
93 
94 	uint32_t	cpsw_if_flags;
95 	int		cpsw_media_status;
96 
97 	struct {
98 		int resets;
99 		int timer;
100 		struct callout	callout;
101 	} watchdog;
102 
103 	bus_dma_tag_t	mbuf_dtag;
104 
105 	/* An mbuf full of nulls for TX padding. */
106 	bus_dmamap_t null_mbuf_dmamap;
107 	struct mbuf *null_mbuf;
108 	bus_addr_t null_mbuf_paddr;
109 
110 	/* RX and TX buffer tracking */
111 	struct cpsw_queue rx, tx;
112 
113 	/* 64-bit versions of 32-bit hardware statistics counters */
114 	uint64_t shadow_stats[CPSW_SYSCTL_COUNT];
115 
116 	/* CPPI STATERAM has 512 slots for building TX/RX queues. */
117 	/* TODO: Size here supposedly varies with different versions
118 	   of the controller.  Check DaVinci specs and find a good
119 	   way to adjust this.  One option is to have a separate
120 	   Device Tree parameter for number slots; another option
121 	   is to calculate it from the memory size in the device tree. */
122 	struct cpsw_slot _slots[CPSW_CPPI_RAM_SIZE / sizeof(struct cpsw_cpdma_bd)];
123 	struct cpsw_slots avail;
124 };
125 
126 #endif /*_IF_CPSWVAR_H */
127