1/*-
2 * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/ipmi/ipmivars.h 162562 2006-09-22 22:11:29Z jhb $
27 */
28
29#ifndef __IPMIVARS_H__
30#define __IPMIVARS_H__
31
32struct ipmi_get_info {
33 int iface_type;
34 uint64_t address;
35 int offset;
36 int io_mode;
37 int irq;
38};
39
40struct ipmi_device;
41
42struct ipmi_request {
43 TAILQ_ENTRY(ipmi_request) ir_link;
44 struct ipmi_device *ir_owner; /* Driver uses NULL. */
45 u_char *ir_request; /* Request is data to send to BMC. */
46 size_t ir_requestlen;
47 u_char *ir_reply; /* Reply is data read from BMC. */
48 size_t ir_replybuflen; /* Length of ir_reply[] buffer. */
49 int ir_replylen; /* Length of reply from BMC. */
50 int ir_error;
51 long ir_msgid;
52 uint8_t ir_addr;
53 uint8_t ir_command;
54 uint8_t ir_compcode;
55};
56
57#define MAX_RES 3
58#define KCS_DATA 0
59#define KCS_CTL_STS 1
60#define SMIC_DATA 0
61#define SMIC_CTL_STS 1
62#define SMIC_FLAGS 2
63
64struct ipmi_softc;
65
66/* Per struct cdev data. */
67struct ipmi_device {
68 TAILQ_ENTRY(ipmi_device) ipmi_link;
69 TAILQ_HEAD(,ipmi_request) ipmi_completed_requests;
70 struct selinfo ipmi_select;
71 struct ipmi_softc *ipmi_softc;
72 struct cdev *ipmi_cdev;
73 int ipmi_open;
74 int ipmi_closing;
75 int ipmi_requests;
76 u_char ipmi_address; /* IPMB address. */
77 u_char ipmi_lun;
78};
79
80struct ipmi_kcs {
81};
82
83struct ipmi_smic {
84};
85
86struct ipmi_ssif {
87 device_t smbus;
88 int smbus_address;
89};
90
91struct ipmi_softc {
92 device_t ipmi_dev;
93 union {
94 struct ipmi_kcs kcs;
95 struct ipmi_smic smic;
96 struct ipmi_ssif ssif;
97 } _iface;
98 int ipmi_io_rid;
99 int ipmi_io_type;
100 struct resource *ipmi_io_res[MAX_RES];
101 int ipmi_io_spacing;
102 int ipmi_irq_rid;
103 struct resource *ipmi_irq_res;
104 void *ipmi_irq;
105 int ipmi_detaching;
106#ifdef CLONING
107 int ipmi_cloning;
108 u_int ipmi_cdev_mask;
109 TAILQ_HEAD(,ipmi_device) ipmi_cdevs;
110#else
111 struct ipmi_device ipmi_idev;
112#endif
113 TAILQ_HEAD(,ipmi_request) ipmi_pending_requests;
114#ifdef CLONING
115 eventhandler_tag ipmi_clone_tag;
116#endif
117 eventhandler_tag ipmi_watchdog_tag;
118 struct intr_config_hook ipmi_ich;
119 struct mtx ipmi_lock;
120 struct cv ipmi_request_added;
121 struct proc *ipmi_kthread;
122 driver_intr_t *ipmi_intr;
123 int (*ipmi_startup)(struct ipmi_softc *);
124 int (*ipmi_enqueue_request)(struct ipmi_softc *, struct ipmi_request *);
125};
126
127#define ipmi_ssif_smbus_address _iface.ssif.smbus_address
128#define ipmi_ssif_smbus _iface.ssif.smbus
129
130struct ipmi_ipmb {
131 u_char foo;
132};
133
134#define KCS_MODE 0x01
135#define SMIC_MODE 0x02
136#define BT_MODE 0x03
137#define SSIF_MODE 0x04
138
139/* KCS status flags */
140#define KCS_STATUS_OBF 0x01 /* Data Out ready from BMC */
141#define KCS_STATUS_IBF 0x02 /* Data In from System */
142#define KCS_STATUS_SMS_ATN 0x04 /* Ready in RX queue */
143#define KCS_STATUS_C_D 0x08 /* Command/Data register write*/
144#define KCS_STATUS_OEM1 0x10
145#define KCS_STATUS_OEM2 0x20
146#define KCS_STATUS_S0 0x40
147#define KCS_STATUS_S1 0x80
148 #define KCS_STATUS_STATE(x) ((x)>>6)
149 #define KCS_STATUS_STATE_IDLE 0x0
150 #define KCS_STATUS_STATE_READ 0x1
151 #define KCS_STATUS_STATE_WRITE 0x2
152 #define KCS_STATUS_STATE_ERROR 0x3
153#define KCS_IFACE_STATUS_OK 0x00
154#define KCS_IFACE_STATUS_ABORT 0x01
155#define KCS_IFACE_STATUS_ILLEGAL 0x02
156#define KCS_IFACE_STATUS_LENGTH_ERR 0x06
157#define KCS_IFACE_STATUS_UNKNOWN_ERR 0xff
158
159/* KCS control codes */
160#define KCS_CONTROL_GET_STATUS_ABORT 0x60
161#define KCS_CONTROL_WRITE_START 0x61
162#define KCS_CONTROL_WRITE_END 0x62
163#define KCS_DATA_IN_READ 0x68
164
165/* SMIC status flags */
166#define SMIC_STATUS_BUSY 0x01 /* System set and BMC clears it */
167#define SMIC_STATUS_SMS_ATN 0x04 /* BMC has a message */
168#define SMIC_STATUS_EVT_ATN 0x08 /* Event has been RX */
169#define SMIC_STATUS_SMI 0x10 /* asserted SMI */
170#define SMIC_STATUS_TX_RDY 0x40 /* Ready to accept WRITE */
171#define SMIC_STATUS_RX_RDY 0x80 /* Ready to read */
172#define SMIC_STATUS_RESERVED 0x22
173
174/* SMIC control codes */
175#define SMIC_CC_SMS_GET_STATUS 0x40
176#define SMIC_CC_SMS_WR_START 0x41
177#define SMIC_CC_SMS_WR_NEXT 0x42
178#define SMIC_CC_SMS_WR_END 0x43
179#define SMIC_CC_SMS_RD_START 0x44
180#define SMIC_CC_SMS_RD_NEXT 0x45
181#define SMIC_CC_SMS_RD_END 0x46
182
183/* SMIC status codes */
184#define SMIC_SC_SMS_RDY 0xc0
185#define SMIC_SC_SMS_WR_START 0xc1
186#define SMIC_SC_SMS_WR_NEXT 0xc2
187#define SMIC_SC_SMS_WR_END 0xc3
188#define SMIC_SC_SMS_RD_START 0xc4
189#define SMIC_SC_SMS_RD_NEXT 0xc5
190#define SMIC_SC_SMS_RD_END 0xc6
191
192#define IPMI_ADDR(netfn, lun) ((netfn) << 2 | (lun))
193#define IPMI_REPLY_ADDR(addr) ((addr) + 0x4)
194
195#define IPMI_LOCK(sc) mtx_lock(&(sc)->ipmi_lock)
196#define IPMI_UNLOCK(sc) mtx_unlock(&(sc)->ipmi_lock)
197#define IPMI_LOCK_ASSERT(sc) mtx_assert(&(sc)->ipmi_lock, MA_OWNED)
198
199#define ipmi_alloc_driver_request(addr, cmd, reqlen, replylen) \
200 ipmi_alloc_request(NULL, 0, (addr), (cmd), (reqlen), (replylen))
201
202#if __FreeBSD_version < 601105
203#define bus_read_1(r, o) \
204 bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), (o))
205#define bus_write_1(r, o, v) \
206 bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), (o), (v))
207#endif
208
209/* I/O to a single I/O resource. */
210#define INB_SINGLE(sc, x) \
211 bus_read_1((sc)->ipmi_io_res[0], (sc)->ipmi_io_spacing * (x))
212#define OUTB_SINGLE(sc, x, value) \
213 bus_write_1((sc)->ipmi_io_res[0], (sc)->ipmi_io_spacing * (x), value)
214
215/* I/O with each register in its in I/O resource. */
216#define INB_MULTIPLE(sc, x) \
217 bus_read_1((sc)->ipmi_io_res[(x)], 0)
218#define OUTB_MULTIPLE(sc, x, value) \
219 bus_write_1((sc)->ipmi_io_res[(x)], 0, value)
220
221/*
222 * Determine I/O method based on whether or not we have more than one I/O
223 * resource.
224 */
225#define INB(sc, x) \
226 ((sc)->ipmi_io_res[1] != NULL ? INB_MULTIPLE(sc, x) : INB_SINGLE(sc, x))
227#define OUTB(sc, x, value) \
228 ((sc)->ipmi_io_res[1] != NULL ? OUTB_MULTIPLE(sc, x, value) : \
229 OUTB_SINGLE(sc, x, value))
230
231#define MAX_TIMEOUT 3 * hz
232
233int ipmi_attach(device_t);
234int ipmi_detach(device_t);
235void ipmi_release_resources(device_t);
236
237/* Manage requests. */
238struct ipmi_request *ipmi_alloc_request(struct ipmi_device *, long, uint8_t,
239 uint8_t, size_t, size_t);
240void ipmi_complete_request(struct ipmi_softc *, struct ipmi_request *);
241struct ipmi_request *ipmi_dequeue_request(struct ipmi_softc *);
242void ipmi_free_request(struct ipmi_request *);
243int ipmi_polled_enqueue_request(struct ipmi_softc *, struct ipmi_request *);
244int ipmi_submit_driver_request(struct ipmi_softc *, struct ipmi_request *,
245 int);
246
247/* Identify BMC interface via SMBIOS. */
248int ipmi_smbios_identify(struct ipmi_get_info *);
249
250/* Match BMC PCI device listed in SMBIOS. */
251const char *ipmi_pci_match(uint16_t, uint16_t);
252
253/* Interface attach routines. */
254int ipmi_kcs_attach(struct ipmi_softc *);
255int ipmi_kcs_probe_align(struct ipmi_softc *);
256int ipmi_smic_attach(struct ipmi_softc *);
257int ipmi_ssif_attach(struct ipmi_softc *, device_t, int);
258
259#ifdef IPMB
260int ipmi_handle_attn(struct ipmi_softc *);
261#endif
262
263extern devclass_t ipmi_devclass;
264extern int ipmi_attached;
265
266#endif /* !__IPMIVARS_H__ */
2 * Copyright (c) 2006 IronPort Systems Inc. <ambrisko@ironport.com>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
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.
13 *
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
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sys/dev/ipmi/ipmivars.h 162562 2006-09-22 22:11:29Z jhb $
27 */
28
29#ifndef __IPMIVARS_H__
30#define __IPMIVARS_H__
31
32struct ipmi_get_info {
33 int iface_type;
34 uint64_t address;
35 int offset;
36 int io_mode;
37 int irq;
38};
39
40struct ipmi_device;
41
42struct ipmi_request {
43 TAILQ_ENTRY(ipmi_request) ir_link;
44 struct ipmi_device *ir_owner; /* Driver uses NULL. */
45 u_char *ir_request; /* Request is data to send to BMC. */
46 size_t ir_requestlen;
47 u_char *ir_reply; /* Reply is data read from BMC. */
48 size_t ir_replybuflen; /* Length of ir_reply[] buffer. */
49 int ir_replylen; /* Length of reply from BMC. */
50 int ir_error;
51 long ir_msgid;
52 uint8_t ir_addr;
53 uint8_t ir_command;
54 uint8_t ir_compcode;
55};
56
57#define MAX_RES 3
58#define KCS_DATA 0
59#define KCS_CTL_STS 1
60#define SMIC_DATA 0
61#define SMIC_CTL_STS 1
62#define SMIC_FLAGS 2
63
64struct ipmi_softc;
65
66/* Per struct cdev data. */
67struct ipmi_device {
68 TAILQ_ENTRY(ipmi_device) ipmi_link;
69 TAILQ_HEAD(,ipmi_request) ipmi_completed_requests;
70 struct selinfo ipmi_select;
71 struct ipmi_softc *ipmi_softc;
72 struct cdev *ipmi_cdev;
73 int ipmi_open;
74 int ipmi_closing;
75 int ipmi_requests;
76 u_char ipmi_address; /* IPMB address. */
77 u_char ipmi_lun;
78};
79
80struct ipmi_kcs {
81};
82
83struct ipmi_smic {
84};
85
86struct ipmi_ssif {
87 device_t smbus;
88 int smbus_address;
89};
90
91struct ipmi_softc {
92 device_t ipmi_dev;
93 union {
94 struct ipmi_kcs kcs;
95 struct ipmi_smic smic;
96 struct ipmi_ssif ssif;
97 } _iface;
98 int ipmi_io_rid;
99 int ipmi_io_type;
100 struct resource *ipmi_io_res[MAX_RES];
101 int ipmi_io_spacing;
102 int ipmi_irq_rid;
103 struct resource *ipmi_irq_res;
104 void *ipmi_irq;
105 int ipmi_detaching;
106#ifdef CLONING
107 int ipmi_cloning;
108 u_int ipmi_cdev_mask;
109 TAILQ_HEAD(,ipmi_device) ipmi_cdevs;
110#else
111 struct ipmi_device ipmi_idev;
112#endif
113 TAILQ_HEAD(,ipmi_request) ipmi_pending_requests;
114#ifdef CLONING
115 eventhandler_tag ipmi_clone_tag;
116#endif
117 eventhandler_tag ipmi_watchdog_tag;
118 struct intr_config_hook ipmi_ich;
119 struct mtx ipmi_lock;
120 struct cv ipmi_request_added;
121 struct proc *ipmi_kthread;
122 driver_intr_t *ipmi_intr;
123 int (*ipmi_startup)(struct ipmi_softc *);
124 int (*ipmi_enqueue_request)(struct ipmi_softc *, struct ipmi_request *);
125};
126
127#define ipmi_ssif_smbus_address _iface.ssif.smbus_address
128#define ipmi_ssif_smbus _iface.ssif.smbus
129
130struct ipmi_ipmb {
131 u_char foo;
132};
133
134#define KCS_MODE 0x01
135#define SMIC_MODE 0x02
136#define BT_MODE 0x03
137#define SSIF_MODE 0x04
138
139/* KCS status flags */
140#define KCS_STATUS_OBF 0x01 /* Data Out ready from BMC */
141#define KCS_STATUS_IBF 0x02 /* Data In from System */
142#define KCS_STATUS_SMS_ATN 0x04 /* Ready in RX queue */
143#define KCS_STATUS_C_D 0x08 /* Command/Data register write*/
144#define KCS_STATUS_OEM1 0x10
145#define KCS_STATUS_OEM2 0x20
146#define KCS_STATUS_S0 0x40
147#define KCS_STATUS_S1 0x80
148 #define KCS_STATUS_STATE(x) ((x)>>6)
149 #define KCS_STATUS_STATE_IDLE 0x0
150 #define KCS_STATUS_STATE_READ 0x1
151 #define KCS_STATUS_STATE_WRITE 0x2
152 #define KCS_STATUS_STATE_ERROR 0x3
153#define KCS_IFACE_STATUS_OK 0x00
154#define KCS_IFACE_STATUS_ABORT 0x01
155#define KCS_IFACE_STATUS_ILLEGAL 0x02
156#define KCS_IFACE_STATUS_LENGTH_ERR 0x06
157#define KCS_IFACE_STATUS_UNKNOWN_ERR 0xff
158
159/* KCS control codes */
160#define KCS_CONTROL_GET_STATUS_ABORT 0x60
161#define KCS_CONTROL_WRITE_START 0x61
162#define KCS_CONTROL_WRITE_END 0x62
163#define KCS_DATA_IN_READ 0x68
164
165/* SMIC status flags */
166#define SMIC_STATUS_BUSY 0x01 /* System set and BMC clears it */
167#define SMIC_STATUS_SMS_ATN 0x04 /* BMC has a message */
168#define SMIC_STATUS_EVT_ATN 0x08 /* Event has been RX */
169#define SMIC_STATUS_SMI 0x10 /* asserted SMI */
170#define SMIC_STATUS_TX_RDY 0x40 /* Ready to accept WRITE */
171#define SMIC_STATUS_RX_RDY 0x80 /* Ready to read */
172#define SMIC_STATUS_RESERVED 0x22
173
174/* SMIC control codes */
175#define SMIC_CC_SMS_GET_STATUS 0x40
176#define SMIC_CC_SMS_WR_START 0x41
177#define SMIC_CC_SMS_WR_NEXT 0x42
178#define SMIC_CC_SMS_WR_END 0x43
179#define SMIC_CC_SMS_RD_START 0x44
180#define SMIC_CC_SMS_RD_NEXT 0x45
181#define SMIC_CC_SMS_RD_END 0x46
182
183/* SMIC status codes */
184#define SMIC_SC_SMS_RDY 0xc0
185#define SMIC_SC_SMS_WR_START 0xc1
186#define SMIC_SC_SMS_WR_NEXT 0xc2
187#define SMIC_SC_SMS_WR_END 0xc3
188#define SMIC_SC_SMS_RD_START 0xc4
189#define SMIC_SC_SMS_RD_NEXT 0xc5
190#define SMIC_SC_SMS_RD_END 0xc6
191
192#define IPMI_ADDR(netfn, lun) ((netfn) << 2 | (lun))
193#define IPMI_REPLY_ADDR(addr) ((addr) + 0x4)
194
195#define IPMI_LOCK(sc) mtx_lock(&(sc)->ipmi_lock)
196#define IPMI_UNLOCK(sc) mtx_unlock(&(sc)->ipmi_lock)
197#define IPMI_LOCK_ASSERT(sc) mtx_assert(&(sc)->ipmi_lock, MA_OWNED)
198
199#define ipmi_alloc_driver_request(addr, cmd, reqlen, replylen) \
200 ipmi_alloc_request(NULL, 0, (addr), (cmd), (reqlen), (replylen))
201
202#if __FreeBSD_version < 601105
203#define bus_read_1(r, o) \
204 bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), (o))
205#define bus_write_1(r, o, v) \
206 bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), (o), (v))
207#endif
208
209/* I/O to a single I/O resource. */
210#define INB_SINGLE(sc, x) \
211 bus_read_1((sc)->ipmi_io_res[0], (sc)->ipmi_io_spacing * (x))
212#define OUTB_SINGLE(sc, x, value) \
213 bus_write_1((sc)->ipmi_io_res[0], (sc)->ipmi_io_spacing * (x), value)
214
215/* I/O with each register in its in I/O resource. */
216#define INB_MULTIPLE(sc, x) \
217 bus_read_1((sc)->ipmi_io_res[(x)], 0)
218#define OUTB_MULTIPLE(sc, x, value) \
219 bus_write_1((sc)->ipmi_io_res[(x)], 0, value)
220
221/*
222 * Determine I/O method based on whether or not we have more than one I/O
223 * resource.
224 */
225#define INB(sc, x) \
226 ((sc)->ipmi_io_res[1] != NULL ? INB_MULTIPLE(sc, x) : INB_SINGLE(sc, x))
227#define OUTB(sc, x, value) \
228 ((sc)->ipmi_io_res[1] != NULL ? OUTB_MULTIPLE(sc, x, value) : \
229 OUTB_SINGLE(sc, x, value))
230
231#define MAX_TIMEOUT 3 * hz
232
233int ipmi_attach(device_t);
234int ipmi_detach(device_t);
235void ipmi_release_resources(device_t);
236
237/* Manage requests. */
238struct ipmi_request *ipmi_alloc_request(struct ipmi_device *, long, uint8_t,
239 uint8_t, size_t, size_t);
240void ipmi_complete_request(struct ipmi_softc *, struct ipmi_request *);
241struct ipmi_request *ipmi_dequeue_request(struct ipmi_softc *);
242void ipmi_free_request(struct ipmi_request *);
243int ipmi_polled_enqueue_request(struct ipmi_softc *, struct ipmi_request *);
244int ipmi_submit_driver_request(struct ipmi_softc *, struct ipmi_request *,
245 int);
246
247/* Identify BMC interface via SMBIOS. */
248int ipmi_smbios_identify(struct ipmi_get_info *);
249
250/* Match BMC PCI device listed in SMBIOS. */
251const char *ipmi_pci_match(uint16_t, uint16_t);
252
253/* Interface attach routines. */
254int ipmi_kcs_attach(struct ipmi_softc *);
255int ipmi_kcs_probe_align(struct ipmi_softc *);
256int ipmi_smic_attach(struct ipmi_softc *);
257int ipmi_ssif_attach(struct ipmi_softc *, device_t, int);
258
259#ifdef IPMB
260int ipmi_handle_attn(struct ipmi_softc *);
261#endif
262
263extern devclass_t ipmi_devclass;
264extern int ipmi_attached;
265
266#endif /* !__IPMIVARS_H__ */