1155517Sambrisko/*- 2155517Sambrisko * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com> 3155517Sambrisko * All rights reserved. 4155517Sambrisko * 5155517Sambrisko * Redistribution and use in source and binary forms, with or without 6155517Sambrisko * modification, are permitted provided that the following conditions 7155517Sambrisko * are met: 8155517Sambrisko * 1. Redistributions of source code must retain the above copyright 9155517Sambrisko * notice, this list of conditions and the following disclaimer. 10155517Sambrisko * 2. Redistributions in binary form must reproduce the above copyright 11155517Sambrisko * notice, this list of conditions and the following disclaimer in the 12155517Sambrisko * documentation and/or other materials provided with the distribution. 13155517Sambrisko * 14155517Sambrisko * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15155517Sambrisko * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16155517Sambrisko * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17155517Sambrisko * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18155517Sambrisko * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19155517Sambrisko * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20155517Sambrisko * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21155517Sambrisko * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22155517Sambrisko * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23155517Sambrisko * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24155517Sambrisko * SUCH DAMAGE. 25155517Sambrisko * 26155517Sambrisko * $FreeBSD$ 27155517Sambrisko */ 28155517Sambrisko 29162562Sjhb#ifndef __IPMIVARS_H__ 30162562Sjhb#define __IPMIVARS_H__ 31162562Sjhb 32155517Sambriskostruct ipmi_get_info { 33162562Sjhb int iface_type; 34155517Sambrisko uint64_t address; 35155517Sambrisko int offset; 36155517Sambrisko int io_mode; 37162562Sjhb int irq; 38155517Sambrisko}; 39155517Sambrisko 40162562Sjhbstruct ipmi_device; 41162562Sjhb 42162562Sjhbstruct ipmi_request { 43162562Sjhb TAILQ_ENTRY(ipmi_request) ir_link; 44162562Sjhb struct ipmi_device *ir_owner; /* Driver uses NULL. */ 45162562Sjhb u_char *ir_request; /* Request is data to send to BMC. */ 46162562Sjhb size_t ir_requestlen; 47162562Sjhb u_char *ir_reply; /* Reply is data read from BMC. */ 48162562Sjhb size_t ir_replybuflen; /* Length of ir_reply[] buffer. */ 49162562Sjhb int ir_replylen; /* Length of reply from BMC. */ 50162562Sjhb int ir_error; 51162562Sjhb long ir_msgid; 52162562Sjhb uint8_t ir_addr; 53162562Sjhb uint8_t ir_command; 54162562Sjhb uint8_t ir_compcode; 55162562Sjhb}; 56162562Sjhb 57162562Sjhb#define MAX_RES 3 58162562Sjhb#define KCS_DATA 0 59162562Sjhb#define KCS_CTL_STS 1 60162562Sjhb#define SMIC_DATA 0 61162562Sjhb#define SMIC_CTL_STS 1 62162562Sjhb#define SMIC_FLAGS 2 63162562Sjhb 64162562Sjhbstruct ipmi_softc; 65162562Sjhb 66182322Sjhb/* Per file descriptor data. */ 67162562Sjhbstruct ipmi_device { 68162562Sjhb TAILQ_ENTRY(ipmi_device) ipmi_link; 69162562Sjhb TAILQ_HEAD(,ipmi_request) ipmi_completed_requests; 70162562Sjhb struct selinfo ipmi_select; 71162562Sjhb struct ipmi_softc *ipmi_softc; 72162562Sjhb int ipmi_closing; 73162562Sjhb int ipmi_requests; 74162562Sjhb u_char ipmi_address; /* IPMB address. */ 75162562Sjhb u_char ipmi_lun; 76162562Sjhb}; 77162562Sjhb 78162562Sjhbstruct ipmi_kcs { 79162562Sjhb}; 80162562Sjhb 81162562Sjhbstruct ipmi_smic { 82162562Sjhb}; 83162562Sjhb 84162562Sjhbstruct ipmi_ssif { 85162562Sjhb device_t smbus; 86162562Sjhb int smbus_address; 87162562Sjhb}; 88162562Sjhb 89155517Sambriskostruct ipmi_softc { 90155517Sambrisko device_t ipmi_dev; 91162562Sjhb union { 92162562Sjhb struct ipmi_kcs kcs; 93162562Sjhb struct ipmi_smic smic; 94162562Sjhb struct ipmi_ssif ssif; 95162562Sjhb } _iface; 96155517Sambrisko int ipmi_io_rid; 97162562Sjhb int ipmi_io_type; 98162562Sjhb struct resource *ipmi_io_res[MAX_RES]; 99162562Sjhb int ipmi_io_spacing; 100155517Sambrisko int ipmi_irq_rid; 101162562Sjhb struct resource *ipmi_irq_res; 102155517Sambrisko void *ipmi_irq; 103162562Sjhb int ipmi_detaching; 104182322Sjhb int ipmi_opened; 105182322Sjhb struct cdev *ipmi_cdev; 106162562Sjhb TAILQ_HEAD(,ipmi_request) ipmi_pending_requests; 107162562Sjhb eventhandler_tag ipmi_watchdog_tag; 108239128Sjhb int ipmi_watchdog_active; 109162562Sjhb struct intr_config_hook ipmi_ich; 110162562Sjhb struct mtx ipmi_lock; 111162562Sjhb struct cv ipmi_request_added; 112162562Sjhb struct proc *ipmi_kthread; 113162562Sjhb driver_intr_t *ipmi_intr; 114162562Sjhb int (*ipmi_startup)(struct ipmi_softc *); 115162562Sjhb int (*ipmi_enqueue_request)(struct ipmi_softc *, struct ipmi_request *); 116155517Sambrisko}; 117155517Sambrisko 118162562Sjhb#define ipmi_ssif_smbus_address _iface.ssif.smbus_address 119162562Sjhb#define ipmi_ssif_smbus _iface.ssif.smbus 120162562Sjhb 121155517Sambriskostruct ipmi_ipmb { 122155517Sambrisko u_char foo; 123155517Sambrisko}; 124155517Sambrisko 125162562Sjhb#define KCS_MODE 0x01 126162562Sjhb#define SMIC_MODE 0x02 127162562Sjhb#define BT_MODE 0x03 128162562Sjhb#define SSIF_MODE 0x04 129162562Sjhb 130155517Sambrisko/* KCS status flags */ 131155517Sambrisko#define KCS_STATUS_OBF 0x01 /* Data Out ready from BMC */ 132155517Sambrisko#define KCS_STATUS_IBF 0x02 /* Data In from System */ 133155517Sambrisko#define KCS_STATUS_SMS_ATN 0x04 /* Ready in RX queue */ 134155517Sambrisko#define KCS_STATUS_C_D 0x08 /* Command/Data register write*/ 135155517Sambrisko#define KCS_STATUS_OEM1 0x10 136155517Sambrisko#define KCS_STATUS_OEM2 0x20 137155517Sambrisko#define KCS_STATUS_S0 0x40 138155517Sambrisko#define KCS_STATUS_S1 0x80 139155517Sambrisko #define KCS_STATUS_STATE(x) ((x)>>6) 140155517Sambrisko #define KCS_STATUS_STATE_IDLE 0x0 141155517Sambrisko #define KCS_STATUS_STATE_READ 0x1 142155517Sambrisko #define KCS_STATUS_STATE_WRITE 0x2 143155517Sambrisko #define KCS_STATUS_STATE_ERROR 0x3 144162562Sjhb#define KCS_IFACE_STATUS_OK 0x00 145155517Sambrisko#define KCS_IFACE_STATUS_ABORT 0x01 146155517Sambrisko#define KCS_IFACE_STATUS_ILLEGAL 0x02 147155517Sambrisko#define KCS_IFACE_STATUS_LENGTH_ERR 0x06 148162562Sjhb#define KCS_IFACE_STATUS_UNKNOWN_ERR 0xff 149155517Sambrisko 150162562Sjhb/* KCS control codes */ 151155517Sambrisko#define KCS_CONTROL_GET_STATUS_ABORT 0x60 152155517Sambrisko#define KCS_CONTROL_WRITE_START 0x61 153155517Sambrisko#define KCS_CONTROL_WRITE_END 0x62 154155517Sambrisko#define KCS_DATA_IN_READ 0x68 155155517Sambrisko 156155517Sambrisko/* SMIC status flags */ 157155517Sambrisko#define SMIC_STATUS_BUSY 0x01 /* System set and BMC clears it */ 158155517Sambrisko#define SMIC_STATUS_SMS_ATN 0x04 /* BMC has a message */ 159155517Sambrisko#define SMIC_STATUS_EVT_ATN 0x08 /* Event has been RX */ 160162562Sjhb#define SMIC_STATUS_SMI 0x10 /* asserted SMI */ 161155517Sambrisko#define SMIC_STATUS_TX_RDY 0x40 /* Ready to accept WRITE */ 162155517Sambrisko#define SMIC_STATUS_RX_RDY 0x80 /* Ready to read */ 163162562Sjhb#define SMIC_STATUS_RESERVED 0x22 164155517Sambrisko 165155517Sambrisko/* SMIC control codes */ 166155517Sambrisko#define SMIC_CC_SMS_GET_STATUS 0x40 167155517Sambrisko#define SMIC_CC_SMS_WR_START 0x41 168155517Sambrisko#define SMIC_CC_SMS_WR_NEXT 0x42 169155517Sambrisko#define SMIC_CC_SMS_WR_END 0x43 170155517Sambrisko#define SMIC_CC_SMS_RD_START 0x44 171155517Sambrisko#define SMIC_CC_SMS_RD_NEXT 0x45 172155517Sambrisko#define SMIC_CC_SMS_RD_END 0x46 173155517Sambrisko 174155517Sambrisko/* SMIC status codes */ 175155517Sambrisko#define SMIC_SC_SMS_RDY 0xc0 176155517Sambrisko#define SMIC_SC_SMS_WR_START 0xc1 177155517Sambrisko#define SMIC_SC_SMS_WR_NEXT 0xc2 178155517Sambrisko#define SMIC_SC_SMS_WR_END 0xc3 179155517Sambrisko#define SMIC_SC_SMS_RD_START 0xc4 180155517Sambrisko#define SMIC_SC_SMS_RD_NEXT 0xc5 181155517Sambrisko#define SMIC_SC_SMS_RD_END 0xc6 182155517Sambrisko 183162562Sjhb#define IPMI_ADDR(netfn, lun) ((netfn) << 2 | (lun)) 184162562Sjhb#define IPMI_REPLY_ADDR(addr) ((addr) + 0x4) 185155517Sambrisko 186162562Sjhb#define IPMI_LOCK(sc) mtx_lock(&(sc)->ipmi_lock) 187162562Sjhb#define IPMI_UNLOCK(sc) mtx_unlock(&(sc)->ipmi_lock) 188162562Sjhb#define IPMI_LOCK_ASSERT(sc) mtx_assert(&(sc)->ipmi_lock, MA_OWNED) 189155517Sambrisko 190162562Sjhb#define ipmi_alloc_driver_request(addr, cmd, reqlen, replylen) \ 191162562Sjhb ipmi_alloc_request(NULL, 0, (addr), (cmd), (reqlen), (replylen)) 192162562Sjhb 193162562Sjhb#if __FreeBSD_version < 601105 194162562Sjhb#define bus_read_1(r, o) \ 195162562Sjhb bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), (o)) 196162562Sjhb#define bus_write_1(r, o, v) \ 197162562Sjhb bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), (o), (v)) 198162562Sjhb#endif 199162562Sjhb 200162562Sjhb/* I/O to a single I/O resource. */ 201162562Sjhb#define INB_SINGLE(sc, x) \ 202162562Sjhb bus_read_1((sc)->ipmi_io_res[0], (sc)->ipmi_io_spacing * (x)) 203162562Sjhb#define OUTB_SINGLE(sc, x, value) \ 204162562Sjhb bus_write_1((sc)->ipmi_io_res[0], (sc)->ipmi_io_spacing * (x), value) 205162562Sjhb 206162562Sjhb/* I/O with each register in its in I/O resource. */ 207162562Sjhb#define INB_MULTIPLE(sc, x) \ 208162562Sjhb bus_read_1((sc)->ipmi_io_res[(x)], 0) 209162562Sjhb#define OUTB_MULTIPLE(sc, x, value) \ 210162562Sjhb bus_write_1((sc)->ipmi_io_res[(x)], 0, value) 211162562Sjhb 212162562Sjhb/* 213162562Sjhb * Determine I/O method based on whether or not we have more than one I/O 214162562Sjhb * resource. 215162562Sjhb */ 216162562Sjhb#define INB(sc, x) \ 217162562Sjhb ((sc)->ipmi_io_res[1] != NULL ? INB_MULTIPLE(sc, x) : INB_SINGLE(sc, x)) 218162562Sjhb#define OUTB(sc, x, value) \ 219162562Sjhb ((sc)->ipmi_io_res[1] != NULL ? OUTB_MULTIPLE(sc, x, value) : \ 220162562Sjhb OUTB_SINGLE(sc, x, value)) 221162562Sjhb 222253812Ssbruno#define MAX_TIMEOUT 6 * hz 223162562Sjhb 224162562Sjhbint ipmi_attach(device_t); 225162562Sjhbint ipmi_detach(device_t); 226162562Sjhbvoid ipmi_release_resources(device_t); 227162562Sjhb 228162562Sjhb/* Manage requests. */ 229162562Sjhbstruct ipmi_request *ipmi_alloc_request(struct ipmi_device *, long, uint8_t, 230162562Sjhb uint8_t, size_t, size_t); 231162562Sjhbvoid ipmi_complete_request(struct ipmi_softc *, struct ipmi_request *); 232162562Sjhbstruct ipmi_request *ipmi_dequeue_request(struct ipmi_softc *); 233162562Sjhbvoid ipmi_free_request(struct ipmi_request *); 234162562Sjhbint ipmi_polled_enqueue_request(struct ipmi_softc *, struct ipmi_request *); 235162562Sjhbint ipmi_submit_driver_request(struct ipmi_softc *, struct ipmi_request *, 236162562Sjhb int); 237162562Sjhb 238162562Sjhb/* Identify BMC interface via SMBIOS. */ 239162562Sjhbint ipmi_smbios_identify(struct ipmi_get_info *); 240162562Sjhb 241162562Sjhb/* Match BMC PCI device listed in SMBIOS. */ 242162562Sjhbconst char *ipmi_pci_match(uint16_t, uint16_t); 243162562Sjhb 244162562Sjhb/* Interface attach routines. */ 245162562Sjhbint ipmi_kcs_attach(struct ipmi_softc *); 246162562Sjhbint ipmi_kcs_probe_align(struct ipmi_softc *); 247162562Sjhbint ipmi_smic_attach(struct ipmi_softc *); 248162562Sjhbint ipmi_ssif_attach(struct ipmi_softc *, device_t, int); 249162562Sjhb 250162562Sjhb#ifdef IPMB 251162562Sjhbint ipmi_handle_attn(struct ipmi_softc *); 252162562Sjhb#endif 253162562Sjhb 254155517Sambriskoextern devclass_t ipmi_devclass; 255155517Sambriskoextern int ipmi_attached; 256162562Sjhb 257162562Sjhb#endif /* !__IPMIVARS_H__ */ 258