summaryrefslogtreecommitdiff
path: root/sys/dev/phy/et131x.c
blob: 52fac6ce69376b750064a6e9f609f0fabafca8a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
/*
 * Copyright (c) 2023-2025 Ian Marco Moffett and the Osmora Team.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of Hyra nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * This driver is the product of reverse engineering
 * work done by Ian Marco Moffett and the OSMORA team.
 *
 * Please refer to share/docs/hw/et131x.txt
 */

#include <sys/types.h>
#include <sys/driver.h>
#include <sys/errno.h>
#include <sys/syslog.h>
#include <sys/mmio.h>
#include <dev/pci/pci.h>
#include <dev/pci/pciregs.h>
#include <dev/phy/et131xregs.h>
#include <dev/timer.h>

#define VENDOR_ID 0x11C1 /* Agere */
#define DEVICE_ID 0xED00

#define pr_trace(fmt, ...) kprintf("et131x: " fmt, ##__VA_ARGS__)
#define pr_error(...) pr_trace(__VA_ARGS__)

static struct pci_device *dev;
static struct timer tmr;

/*
 * Software reset the ET131X
 *
 * @io: Register space
 */
static void
et131x_soft_reset(struct et131x_iospace *io)
{
    uint32_t tmp;

    tmp = (
        MAC_CFG1_RESET_TXMC   |
        MAC_CFG1_RESET_RXMC   |
        MAC_CFG1_RESET_TXFUNC |
        MAC_CFG1_RESET_RXFUNC |
        MAC_CFG1_SOFTRST      |
        MAC_CFG1_SIMRST
    );

    /*
     * Reset the MAC core, bring it down. After that,
     * we perform a global reset to bring the whole
     * chip down.
     */
    mmio_write32(&io->mac.cfg1, tmp);
    mmio_write32(&io->global.sw_reset, GBL_RESET_ALL);

    /*
     * Reset the MAC again for good measure, but
     * this time a little softer. We already slammed
     * the poor thing.
     */
    tmp &= ~(MAC_CFG1_SOFTRST | MAC_CFG1_SIMRST);
    mmio_write32(&io->mac.cfg1, tmp);
    mmio_write32(&io->mac.cfg1, 0);
}

/*
 * Write to the PHY through MII
 *
 * @io: Register space
 * @addr: PHY address
 * @reg: PHY register
 * @v: Value to write
 */
static int
et131x_mii_write(struct et131x_iospace *io, uint8_t addr, uint8_t reg, uint16_t v)
{
    uint16_t mii_addr;
    uint32_t tmp, mgmt_addr_old;
    uint32_t mgmt_cmd_old;
    uint8_t ndelay = 0;
    int retval = 0;

    /* Save MII management regs state */
    mgmt_cmd_old = mmio_read32(&io->mac.mii_mgmt_cmd);
    mgmt_addr_old = mmio_read32(&io->mac.mii_mgmt_addr);
    mii_addr = MAC_MII_ADDR(addr, reg);

    /*
     * Stop any transactions that are currently
     * happening on the MDIO bus and prepare the
     * write.
     */
    mmio_write32(&io->mac.mii_mgmt_cmd, 0);
    mmio_write32(&io->mac.mii_mgmt_addr, mii_addr);
    mmio_write32(&io->mac.mii_mgmt_ctrl, v);

    for (;;) {
        tmr.usleep(50);
        ++ndelay;

        tmp = mmio_read32(&io->mac.mii_mgmt_indicator);
        if (!ISSET(tmp, MAC_MGMT_BUSY))
            break;
        if (ndelay >= 50)
            break;
    }

    if (ndelay >= 50) {
        pr_error("could not write PHY reg %x (status=%x)\n", reg, tmp);
        retval = -EIO;
        goto done;
    }

done:
    /* Stop operations and restore state */
    mmio_write32(&io->mac.mii_mgmt_cmd, 0);
    mmio_write32(&io->mac.mii_mgmt_addr, mgmt_addr_old);
    mmio_write32(&io->mac.mii_mgmt_cmd, mgmt_cmd_old);
    return retval;
}

/*
 * Initialize PCI related things for the
 * chip.
 */
static void
et131x_init_pci(void)
{
    uint32_t tmp;

    /* Enable bus mastering and MMIO */
    tmp = pci_readl(dev, PCIREG_CMDSTATUS);
    tmp |= (PCI_BUS_MASTERING | PCI_MEM_SPACE);
    pci_writel(dev, PCIREG_CMDSTATUS, tmp);
}

/*
 * Blink both LEDs of the card
 *
 * @io: Register space
 * @count: Number of times to blink
 * @delay: Millisecond delay between blinks
 */
static void
et131x_blink(struct et131x_iospace *io, uint32_t count, uint16_t delay)
{
    uint16_t on_val;

    on_val =  (LED_ON << LED_LINK_SHIFT);
    on_val |= (LED_ON << LED_TXRX_SHIFT);
    for (uint32_t i = 0; i < count; ++i) {
        et131x_mii_write(io, 0, PHY_LED2, on_val);
        tmr.msleep(delay);
        et131x_mii_write(io, 0, PHY_LED2, LED_ALL_OFF);
        tmr.msleep(delay);
    }
}

static int
et131x_init(void)
{
    struct pci_lookup lookup;
    struct et131x_iospace *bar;
    int error;

    lookup.vendor_id = VENDOR_ID;
    lookup.device_id = DEVICE_ID;
    dev = pci_get_device(lookup, PCI_VENDOR_ID | PCI_DEVICE_ID);
    if (dev == NULL) {
        return -ENODEV;
    }

    pr_trace("Agere ET1310 Ethernet ctl <phy? at pci%d:%x.%x.%d>\n",
        dev->bus, dev->device_id, dev->func,
        dev->slot);

    /* Try to request a general purpose timer */
    if (req_timer(TIMER_GP, &tmr) != TMRR_SUCCESS) {
        pr_error("failed to fetch general purpose timer\n");
        return -ENODEV;
    }

    /* Ensure it has get_time_usec() */
    if (tmr.usleep == NULL) {
        pr_error("general purpose timer has no usleep()\n");
        return -ENODEV;
    }

    if ((error = pci_map_bar(dev, 0, (void *)&bar)) != 0) {
        return error;
    }

    et131x_init_pci();
    et131x_soft_reset(bar);
    et131x_blink(bar, 4, 150);
    return 0;
}

DRIVER_DEFER(et131x_init, "et131x");