2 * Copyright (c) 2010-2011 Solarflare Communications, Inc.
5 * This software was developed in part by Philip Paeps under contract for
6 * Solarflare Communications, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/condvar.h>
36 #include <sys/mutex.h>
38 #include <sys/syslog.h>
39 #include <sys/taskqueue.h>
41 #include "common/efx.h"
42 #include "common/efx_mcdi.h"
43 #include "common/efx_regs_mcdi.h"
47 #define SFXGE_MCDI_POLL_INTERVAL_MIN 10 /* 10us in 1us units */
48 #define SFXGE_MCDI_POLL_INTERVAL_MAX 100000 /* 100ms in 1us units */
49 #define SFXGE_MCDI_WATCHDOG_INTERVAL 10000000 /* 10s in 1us units */
51 /* Acquire exclusive access to MCDI for the duration of a request. */
53 sfxge_mcdi_acquire(struct sfxge_mcdi *mcdi)
56 mtx_lock(&mcdi->lock);
57 KASSERT(mcdi->state != SFXGE_MCDI_UNINITIALIZED,
58 ("MCDI not initialized"));
60 while (mcdi->state != SFXGE_MCDI_INITIALIZED)
61 (void)cv_wait_sig(&mcdi->cv, &mcdi->lock);
62 mcdi->state = SFXGE_MCDI_BUSY;
64 mtx_unlock(&mcdi->lock);
67 /* Release ownership of MCDI on request completion. */
69 sfxge_mcdi_release(struct sfxge_mcdi *mcdi)
72 mtx_lock(&mcdi->lock);
73 KASSERT((mcdi->state == SFXGE_MCDI_BUSY ||
74 mcdi->state == SFXGE_MCDI_COMPLETED),
75 ("MCDI not busy or task not completed"));
77 mcdi->state = SFXGE_MCDI_INITIALIZED;
78 cv_broadcast(&mcdi->cv);
80 mtx_unlock(&mcdi->lock);
84 sfxge_mcdi_timeout(struct sfxge_softc *sc)
86 device_t dev = sc->dev;
88 log(LOG_WARNING, "[%s%d] MC_TIMEOUT", device_get_name(dev),
89 device_get_unit(dev));
91 EFSYS_PROBE(mcdi_timeout);
92 sfxge_schedule_reset(sc);
96 sfxge_mcdi_poll(struct sfxge_softc *sc)
104 delay_us = SFXGE_MCDI_POLL_INTERVAL_MIN;
108 if (efx_mcdi_request_poll(enp)) {
109 EFSYS_PROBE1(mcdi_delay, clock_t, delay_total);
113 if (delay_total > SFXGE_MCDI_WATCHDOG_INTERVAL) {
114 aborted = efx_mcdi_request_abort(enp);
115 KASSERT(aborted, ("abort failed"));
116 sfxge_mcdi_timeout(sc);
120 /* Spin or block depending on delay interval. */
121 if (delay_us < 1000000)
124 pause("mcdi wait", delay_us * hz / 1000000);
126 delay_total += delay_us;
128 /* Exponentially back off the poll frequency. */
129 delay_us = delay_us * 2;
130 if (delay_us > SFXGE_MCDI_POLL_INTERVAL_MAX)
131 delay_us = SFXGE_MCDI_POLL_INTERVAL_MAX;
137 sfxge_mcdi_execute(void *arg, efx_mcdi_req_t *emrp)
139 struct sfxge_softc *sc;
140 struct sfxge_mcdi *mcdi;
142 sc = (struct sfxge_softc *)arg;
145 sfxge_mcdi_acquire(mcdi);
147 /* Issue request and poll for completion. */
148 efx_mcdi_request_start(sc->enp, emrp, B_FALSE);
151 sfxge_mcdi_release(mcdi);
155 sfxge_mcdi_ev_cpl(void *arg)
157 struct sfxge_softc *sc;
158 struct sfxge_mcdi *mcdi;
160 sc = (struct sfxge_softc *)arg;
163 mtx_lock(&mcdi->lock);
164 KASSERT(mcdi->state == SFXGE_MCDI_BUSY, ("MCDI not busy"));
165 mcdi->state = SFXGE_MCDI_COMPLETED;
166 cv_broadcast(&mcdi->cv);
167 mtx_unlock(&mcdi->lock);
171 sfxge_mcdi_exception(void *arg, efx_mcdi_exception_t eme)
173 struct sfxge_softc *sc;
176 sc = (struct sfxge_softc *)arg;
179 log(LOG_WARNING, "[%s%d] MC_%s", device_get_name(dev),
180 device_get_unit(dev),
181 (eme == EFX_MCDI_EXCEPTION_MC_REBOOT)
183 : (eme == EFX_MCDI_EXCEPTION_MC_BADASSERT)
184 ? "BADASSERT" : "UNKNOWN");
186 EFSYS_PROBE(mcdi_exception);
188 sfxge_schedule_reset(sc);
192 sfxge_mcdi_init(struct sfxge_softc *sc)
195 struct sfxge_mcdi *mcdi;
196 efx_mcdi_transport_t *emtp;
201 emtp = &mcdi->transport;
203 KASSERT(mcdi->state == SFXGE_MCDI_UNINITIALIZED,
204 ("MCDI already initialized"));
206 mtx_init(&mcdi->lock, "sfxge_mcdi", NULL, MTX_DEF);
208 mcdi->state = SFXGE_MCDI_INITIALIZED;
210 emtp->emt_context = sc;
211 emtp->emt_execute = sfxge_mcdi_execute;
212 emtp->emt_ev_cpl = sfxge_mcdi_ev_cpl;
213 emtp->emt_exception = sfxge_mcdi_exception;
215 cv_init(&mcdi->cv, "sfxge_mcdi");
217 if ((rc = efx_mcdi_init(enp, emtp)) != 0)
223 mtx_destroy(&mcdi->lock);
224 mcdi->state = SFXGE_MCDI_UNINITIALIZED;
229 sfxge_mcdi_fini(struct sfxge_softc *sc)
231 struct sfxge_mcdi *mcdi;
233 efx_mcdi_transport_t *emtp;
237 emtp = &mcdi->transport;
239 mtx_lock(&mcdi->lock);
240 KASSERT(mcdi->state == SFXGE_MCDI_INITIALIZED,
241 ("MCDI not initialized"));
244 bzero(emtp, sizeof(*emtp));
246 cv_destroy(&mcdi->cv);
247 mtx_unlock(&mcdi->lock);
249 mtx_destroy(&mcdi->lock);