2 * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/condvar.h>
34 #include <sys/eventhandler.h>
35 #include <sys/kernel.h>
36 #include <sys/kthread.h>
38 #include <sys/selinfo.h>
39 #include <machine/bus.h>
46 #include <dev/ipmi/ipmivars.h>
49 static void kcs_clear_obf(struct ipmi_softc *, int);
50 static void kcs_error(struct ipmi_softc *);
51 static int kcs_wait_for_ibf(struct ipmi_softc *, int);
52 static int kcs_wait_for_obf(struct ipmi_softc *, int);
55 kcs_wait_for_ibf(struct ipmi_softc *sc, int state)
57 int status, start = ticks;
59 status = INB(sc, KCS_CTL_STS);
61 /* WAIT FOR IBF = 0 */
62 while (ticks - start < MAX_TIMEOUT && status & KCS_STATUS_IBF) {
64 status = INB(sc, KCS_CTL_STS);
67 /* WAIT FOR IBF = 1 */
68 while (ticks - start < MAX_TIMEOUT &&
69 !(status & KCS_STATUS_IBF)) {
71 status = INB(sc, KCS_CTL_STS);
78 kcs_wait_for_obf(struct ipmi_softc *sc, int state)
80 int status, start = ticks;
82 status = INB(sc, KCS_CTL_STS);
84 /* WAIT FOR OBF = 0 */
85 while (ticks - start < MAX_TIMEOUT && status & KCS_STATUS_OBF) {
87 status = INB(sc, KCS_CTL_STS);
90 /* WAIT FOR OBF = 1 */
91 while (ticks - start < MAX_TIMEOUT &&
92 !(status & KCS_STATUS_OBF)) {
94 status = INB(sc, KCS_CTL_STS);
101 kcs_clear_obf(struct ipmi_softc *sc, int status)
106 if (status & KCS_STATUS_OBF) {
107 data = INB(sc, KCS_DATA);
112 kcs_error(struct ipmi_softc *sc)
117 for (retry = 0; retry < 2; retry++) {
119 /* Wait for IBF = 0 */
120 status = kcs_wait_for_ibf(sc, 0);
123 OUTB(sc, KCS_CTL_STS, KCS_CONTROL_GET_STATUS_ABORT);
125 /* Wait for IBF = 0 */
126 status = kcs_wait_for_ibf(sc, 0);
129 kcs_clear_obf(sc, status);
131 if (status & KCS_STATUS_OBF) {
132 data = INB(sc, KCS_DATA);
134 device_printf(sc->ipmi_dev,
135 "KCS Error Data %02x\n", data);
138 /* 0x00 to DATA_IN */
139 OUTB(sc, KCS_DATA, 0x00);
141 /* Wait for IBF = 0 */
142 status = kcs_wait_for_ibf(sc, 0);
144 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_READ) {
146 /* Wait for OBF = 1 */
147 status = kcs_wait_for_obf(sc, 1);
149 /* Read error status */
150 data = INB(sc, KCS_DATA);
152 device_printf(sc->ipmi_dev, "KCS error: %02x\n",
155 /* Write READ into Data_in */
156 OUTB(sc, KCS_DATA, KCS_DATA_IN_READ);
158 /* Wait for IBF = 0 */
159 status = kcs_wait_for_ibf(sc, 0);
163 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_IDLE) {
164 /* Wait for OBF = 1 */
165 status = kcs_wait_for_obf(sc, 1);
168 kcs_clear_obf(sc, status);
172 device_printf(sc->ipmi_dev, "KCS: Error retry exhausted\n");
176 * Start to write a request. Waits for IBF to clear and then sends the
180 kcs_start_write(struct ipmi_softc *sc)
184 for (retry = 0; retry < 10; retry++) {
185 /* Wait for IBF = 0 */
186 status = kcs_wait_for_ibf(sc, 0);
189 kcs_clear_obf(sc, status);
191 /* Write start to command */
192 OUTB(sc, KCS_CTL_STS, KCS_CONTROL_WRITE_START);
194 /* Wait for IBF = 0 */
195 status = kcs_wait_for_ibf(sc, 0);
196 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_WRITE)
201 if (KCS_STATUS_STATE(status) != KCS_STATUS_STATE_WRITE)
206 kcs_clear_obf(sc, status);
212 * Write a byte of the request message, excluding the last byte of the
213 * message which requires special handling.
216 kcs_write_byte(struct ipmi_softc *sc, u_char data)
221 OUTB(sc, KCS_DATA, data);
223 /* Wait for IBF = 0 */
224 status = kcs_wait_for_ibf(sc, 0);
226 if (KCS_STATUS_STATE(status) != KCS_STATUS_STATE_WRITE)
230 kcs_clear_obf(sc, status);
235 * Write the last byte of a request message.
238 kcs_write_last_byte(struct ipmi_softc *sc, u_char data)
242 /* Write end to command */
243 OUTB(sc, KCS_CTL_STS, KCS_CONTROL_WRITE_END);
245 /* Wait for IBF = 0 */
246 status = kcs_wait_for_ibf(sc, 0);
248 if (KCS_STATUS_STATE(status) != KCS_STATUS_STATE_WRITE)
253 kcs_clear_obf(sc, status);
255 /* Send data byte to DATA. */
256 OUTB(sc, KCS_DATA, data);
261 * Read one byte of the reply message.
264 kcs_read_byte(struct ipmi_softc *sc, u_char *data)
269 /* Wait for IBF = 0 */
270 status = kcs_wait_for_ibf(sc, 0);
273 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_READ) {
275 /* Wait for OBF = 1 */
276 status = kcs_wait_for_obf(sc, 1);
279 *data = INB(sc, KCS_DATA);
281 /* Write READ into Data_in */
282 OUTB(sc, KCS_DATA, KCS_DATA_IN_READ);
287 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_IDLE) {
289 /* Wait for OBF = 1*/
290 status = kcs_wait_for_obf(sc, 1);
293 dummy = INB(sc, KCS_DATA);
302 * Send a request message and collect the reply. Returns true if we
306 kcs_polled_request(struct ipmi_softc *sc, struct ipmi_request *req)
311 /* Send the request. */
312 if (!kcs_start_write(sc)) {
313 device_printf(sc->ipmi_dev, "KCS: Failed to start write\n");
317 device_printf(sc->ipmi_dev, "KCS: WRITE_START... ok\n");
320 if (!kcs_write_byte(sc, req->ir_addr)) {
321 device_printf(sc->ipmi_dev, "KCS: Failed to write address\n");
325 device_printf(sc->ipmi_dev, "KCS: Wrote address: %02x\n", req->ir_addr);
328 if (req->ir_requestlen == 0) {
329 if (!kcs_write_last_byte(sc, req->ir_command)) {
330 device_printf(sc->ipmi_dev,
331 "KCS: Failed to write command\n");
335 device_printf(sc->ipmi_dev, "KCS: Wrote command: %02x\n",
339 if (!kcs_write_byte(sc, req->ir_command)) {
340 device_printf(sc->ipmi_dev,
341 "KCS: Failed to write command\n");
345 device_printf(sc->ipmi_dev, "KCS: Wrote command: %02x\n",
349 cp = req->ir_request;
350 for (i = 0; i < req->ir_requestlen - 1; i++) {
351 if (!kcs_write_byte(sc, *cp++)) {
352 device_printf(sc->ipmi_dev,
353 "KCS: Failed to write data byte %d\n",
358 device_printf(sc->ipmi_dev, "KCS: Wrote data: %02x\n",
363 if (!kcs_write_last_byte(sc, *cp)) {
364 device_printf(sc->ipmi_dev,
365 "KCS: Failed to write last dta byte\n");
369 device_printf(sc->ipmi_dev, "KCS: Wrote last data: %02x\n",
374 /* Read the reply. First, read the NetFn/LUN. */
375 if (kcs_read_byte(sc, &data) != 1) {
376 device_printf(sc->ipmi_dev, "KCS: Failed to read address\n");
380 device_printf(sc->ipmi_dev, "KCS: Read address: %02x\n", data);
382 if (data != IPMI_REPLY_ADDR(req->ir_addr)) {
383 device_printf(sc->ipmi_dev, "KCS: Reply address mismatch\n");
387 /* Next we read the command. */
388 if (kcs_read_byte(sc, &data) != 1) {
389 device_printf(sc->ipmi_dev, "KCS: Failed to read command\n");
393 device_printf(sc->ipmi_dev, "KCS: Read command: %02x\n", data);
395 if (data != req->ir_command) {
396 device_printf(sc->ipmi_dev, "KCS: Command mismatch\n");
400 /* Next we read the completion code. */
401 if (kcs_read_byte(sc, &req->ir_compcode) != 1) {
402 device_printf(sc->ipmi_dev,
403 "KCS: Failed to read completion code\n");
407 device_printf(sc->ipmi_dev, "KCS: Read completion code: %02x\n",
411 /* Finally, read the reply from the BMC. */
414 state = kcs_read_byte(sc, &data);
416 device_printf(sc->ipmi_dev,
417 "KCS: Read failed on byte %d\n", i + 1);
422 if (i < req->ir_replybuflen) {
423 req->ir_reply[i] = data;
425 device_printf(sc->ipmi_dev, "KCS: Read data %02x\n",
428 device_printf(sc->ipmi_dev,
429 "KCS: Read short %02x byte %d\n", data, i + 1);
434 req->ir_replylen = i;
436 device_printf(sc->ipmi_dev, "KCS: READ finished (%d bytes)\n", i);
437 if (req->ir_replybuflen < i)
439 if (req->ir_replybuflen < i && req->ir_replybuflen != 0)
441 device_printf(sc->ipmi_dev,
442 "KCS: Read short: %zd buffer, %d actual\n",
443 req->ir_replybuflen, i);
453 struct ipmi_softc *sc = arg;
454 struct ipmi_request *req;
458 while ((req = ipmi_dequeue_request(sc)) != NULL) {
461 for (i = 0; i < 3 && !ok; i++)
462 ok = kcs_polled_request(sc, req);
468 ipmi_complete_request(sc, req);
475 kcs_startup(struct ipmi_softc *sc)
478 return (kproc_create(kcs_loop, sc, &sc->ipmi_kthread, 0, 0, "%s: kcs",
479 device_get_nameunit(sc->ipmi_dev)));
483 ipmi_kcs_attach(struct ipmi_softc *sc)
487 /* Setup function pointers. */
488 sc->ipmi_startup = kcs_startup;
489 sc->ipmi_enqueue_request = ipmi_polled_enqueue_request;
491 /* See if we can talk to the controller. */
492 status = INB(sc, KCS_CTL_STS);
493 if (status == 0xff) {
494 device_printf(sc->ipmi_dev, "couldn't find it\n");
499 device_printf(sc->ipmi_dev, "KCS: initial state: %02x\n", status);
501 if (status & KCS_STATUS_OBF ||
502 KCS_STATUS_STATE(status) != KCS_STATUS_STATE_IDLE)
509 * Determine the alignment automatically for a PCI attachment. In this case,
510 * any unused bytes will return 0x00 when read. We make use of the C/D bit
511 * in the CTL_STS register to try to start a GET_STATUS transaction. When
512 * we write the command, that bit should be set, so we should get a non-zero
513 * value back when we read CTL_STS if the offset we are testing is the CTL_STS
517 ipmi_kcs_probe_align(struct ipmi_softc *sc)
521 sc->ipmi_io_spacing = 1;
524 device_printf(sc->ipmi_dev, "Trying KCS align %d... ", sc->ipmi_io_spacing);
527 /* Wait for IBF = 0 */
528 status = INB(sc, KCS_CTL_STS);
529 while (status & KCS_STATUS_IBF) {
531 status = INB(sc, KCS_CTL_STS);
534 OUTB(sc, KCS_CTL_STS, KCS_CONTROL_GET_STATUS_ABORT);
536 /* Wait for IBF = 0 */
537 status = INB(sc, KCS_CTL_STS);
538 while (status & KCS_STATUS_IBF) {
540 status = INB(sc, KCS_CTL_STS);
543 /* If we got 0x00 back, then this must not be the CTL_STS register. */
548 sc->ipmi_io_spacing <<= 1;
549 if (sc->ipmi_io_spacing > 4)
557 /* Finish out the transaction. */
560 if (status & KCS_STATUS_OBF)
561 data = INB(sc, KCS_DATA);
563 /* 0x00 to DATA_IN */
564 OUTB(sc, KCS_DATA, 0);
566 /* Wait for IBF = 0 */
567 status = INB(sc, KCS_CTL_STS);
568 while (status & KCS_STATUS_IBF) {
570 status = INB(sc, KCS_CTL_STS);
573 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_READ) {
574 /* Wait for IBF = 1 */
575 while (!(status & KCS_STATUS_OBF)) {
577 status = INB(sc, KCS_CTL_STS);
580 /* Read error status. */
581 data = INB(sc, KCS_DATA);
583 /* Write dummy READ to DATA_IN. */
584 OUTB(sc, KCS_DATA, KCS_DATA_IN_READ);
586 /* Wait for IBF = 0 */
587 status = INB(sc, KCS_CTL_STS);
588 while (status & KCS_STATUS_IBF) {
590 status = INB(sc, KCS_CTL_STS);
594 if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_IDLE) {
595 /* Wait for IBF = 1 */
596 while (!(status & KCS_STATUS_OBF)) {
598 status = INB(sc, KCS_CTL_STS);
602 if (status & KCS_STATUS_OBF)
603 data = INB(sc, KCS_DATA);
605 device_printf(sc->ipmi_dev, "KCS probe: end state %x\n",
606 KCS_STATUS_STATE(status));