989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * All rights reserved.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Redistribution and use in source and binary forms, with or without
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * modification, are permitted provided that the following conditions
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * 1. Redistributions of source code must retain the above copyright
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * notice, this list of conditions and the following disclaimer.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * 2. Redistributions in binary form must reproduce the above copyright
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * notice, this list of conditions and the following disclaimer in the
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * documentation and/or other materials provided with the distribution.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * SUCH DAMAGE.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek/* $FreeBSD: src/sys/dev/ipmi/ipmi_kcs.c,v 1.3 2008/08/28 02:11:04 jhb */
12950e8eb3edc5da750616c08afe6281bf554aeeJerry Jelinek * Copyright 2013, Joyent, Inc. All rights reserved.
1e3934778d15dd08e911e1d050dd7a4949348d93Marcel Telka * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekstatic void kcs_clear_obf(struct ipmi_softc *, int);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekstatic int kcs_wait_for_ibf(struct ipmi_softc *, int);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekstatic int kcs_wait_for_obf(struct ipmi_softc *, int);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_wait_for_ibf(struct ipmi_softc *sc, int state)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* WAIT FOR IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek for (i = 0; i < timeout_usecs && status & KCS_STATUS_IBF;
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* WAIT FOR IBF = 1 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek for (i = 0; i < timeout_usecs && !(status & KCS_STATUS_IBF);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_wait_for_obf(struct ipmi_softc *sc, int state)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* WAIT FOR OBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek for (i = 0; i < timeout_usecs && status & KCS_STATUS_OBF;
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* WAIT FOR OBF = 1 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek for (i = 0; i < timeout_usecs && !(status & KCS_STATUS_OBF);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_clear_obf(struct ipmi_softc *sc, int status)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek OUTB(sc, KCS_CTL_STS, KCS_CONTROL_GET_STATUS_ABORT);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* 0x00 to DATA_IN */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_READ) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for OBF = 1 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Read error status */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Write READ into Data_in */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* IDLE STATE */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_IDLE) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for OBF = 1 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Error retry exhausted");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Start to write a request. Waits for IBF to clear and then sends the
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * WR_START command.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Write start to command */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek OUTB(sc, KCS_CTL_STS, KCS_CONTROL_WRITE_START);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_WRITE)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) != KCS_STATUS_STATE_WRITE)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* error state */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Write a byte of the request message, excluding the last byte of the
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * message which requires special handling.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_write_byte(struct ipmi_softc *sc, uchar_t data)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Data to Data */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) != KCS_STATUS_STATE_WRITE)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Write the last byte of a request message.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_write_last_byte(struct ipmi_softc *sc, uchar_t data)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Write end to command */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) != KCS_STATUS_STATE_WRITE)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* error state */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Clear OBF */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Send data byte to DATA. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Read one byte of the reply message.
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_read_byte(struct ipmi_softc *sc, uchar_t *data)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for IBF = 0 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Read State */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_READ) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for OBF = 1 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Read Data_out */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Write READ into Data_in */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Idle State */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (KCS_STATUS_STATE(status) == KCS_STATUS_STATE_IDLE) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Wait for OBF = 1 */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Read Dummy */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Error State */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek * Send a request message and collect the reply. Returns true if we
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinekkcs_polled_request(struct ipmi_softc *sc, struct ipmi_request *req)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Send the request. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Failed to start write");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Failed to write address");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: Wrote address: %02x", req->ir_addr);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (!kcs_write_last_byte(sc, req->ir_command)) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek "KCS: Failed to write command");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek "KCS: Failed to write command");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek for (i = 0; i < req->ir_requestlen - 1; i++) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek "KCS: Failed to write data byte %d",
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek "KCS: Failed to write last dta byte");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: Wrote last data: %02x",
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Read the reply. First, read the NetFn/LUN. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Failed to read address");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: Read address: %02x", data);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Reply address mismatch");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Next we read the command. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Failed to read command");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: Read command: %02x", data);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Next we read the completion code. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (kcs_read_byte(sc, &req->ir_compcode) != 1) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Failed to read completion code");
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: Read completion code: %02x",
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Finally, read the reply from the BMC. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: READ finished (%d bytes)", i);
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (req->ir_replybuflen < i && req->ir_replybuflen != 0)
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_WARN, "KCS: Read short: %d buffer, %d actual",
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek while ((req = ipmi_dequeue_request(sc)) != NULL) {
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek sc->ipmi_kthread = taskq_create_proc("ipmi_kcs", 1, minclsyspri, 1, 1,
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek if (taskq_dispatch(sc->ipmi_kthread, kcs_loop, (void *) sc,
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* Setup function pointers. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek sc->ipmi_enqueue_request = ipmi_polled_enqueue_request;
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek /* See if we can talk to the controller. */
989f28072d20c73ae0955d6a1e3e2fc74831cb39Jerry Jelinek cmn_err(CE_NOTE, "KCS: initial state: %02x", status);