xref: /qemu/include/hw/net/cadence_gem.h (revision e48fdd9d90423d1530b49bbd61b4bbcb49198b33)
1 /*
2  * QEMU Cadence GEM emulation
3  *
4  * Copyright (c) 2011 Xilinx, Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifndef CADENCE_GEM_H
26 
27 #define TYPE_CADENCE_GEM "cadence_gem"
28 #define CADENCE_GEM(obj) OBJECT_CHECK(CadenceGEMState, (obj), TYPE_CADENCE_GEM)
29 
30 #include "net/net.h"
31 #include "hw/sysbus.h"
32 
33 #define CADENCE_GEM_MAXREG        (0x00000800 / 4) /* Last valid GEM address */
34 
35 /* Max number of words in a DMA descriptor.  */
36 #define DESC_MAX_NUM_WORDS              6
37 
38 #define MAX_PRIORITY_QUEUES             8
39 #define MAX_TYPE1_SCREENERS             16
40 #define MAX_TYPE2_SCREENERS             16
41 
42 typedef struct CadenceGEMState {
43     /*< private >*/
44     SysBusDevice parent_obj;
45 
46     /*< public >*/
47     MemoryRegion iomem;
48     NICState *nic;
49     NICConf conf;
50     qemu_irq irq[MAX_PRIORITY_QUEUES];
51 
52     /* Static properties */
53     uint8_t num_priority_queues;
54     uint8_t num_type1_screeners;
55     uint8_t num_type2_screeners;
56     uint32_t revision;
57 
58     /* GEM registers backing store */
59     uint32_t regs[CADENCE_GEM_MAXREG];
60     /* Mask of register bits which are write only */
61     uint32_t regs_wo[CADENCE_GEM_MAXREG];
62     /* Mask of register bits which are read only */
63     uint32_t regs_ro[CADENCE_GEM_MAXREG];
64     /* Mask of register bits which are clear on read */
65     uint32_t regs_rtc[CADENCE_GEM_MAXREG];
66     /* Mask of register bits which are write 1 to clear */
67     uint32_t regs_w1c[CADENCE_GEM_MAXREG];
68 
69     /* PHY registers backing store */
70     uint16_t phy_regs[32];
71 
72     uint8_t phy_loop; /* Are we in phy loopback? */
73 
74     /* The current DMA descriptor pointers */
75     uint32_t rx_desc_addr[MAX_PRIORITY_QUEUES];
76     uint32_t tx_desc_addr[MAX_PRIORITY_QUEUES];
77 
78     uint8_t can_rx_state; /* Debug only */
79 
80     uint32_t rx_desc[MAX_PRIORITY_QUEUES][DESC_MAX_NUM_WORDS];
81 
82     bool sar_active[4];
83 } CadenceGEMState;
84 
85 #define CADENCE_GEM_H
86 #endif
87