1 // SPDX-License-Identifier: GPL-2.0+
5 * The state-machine driver for an IPMI SMIC driver
7 * It started as a copy of Corey Minyard's driver for the KSC interface
8 * and the kernel patch "mmcdev-patch-245" by HP
10 * modified by: Hannes Schulz <schulz@schwaar.com>
14 * Corey Minyard's driver for the KSC interface has the following
16 * Copyright 2002 MontaVista Software Inc.
18 * the kernel patch "mmcdev-patch-245" by HP has the following
20 * (c) Copyright 2001 Grant Grundler (c) Copyright
21 * 2001 Hewlett-Packard Company
24 #include <linux/kernel.h> /* For printk. */
25 #include <linux/string.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/ipmi_msgdefs.h> /* for completion codes */
29 #include "ipmi_si_sm.h"
31 /* smic_debug is a bit-field
32 * SMIC_DEBUG_ENABLE - turned on for now
33 * SMIC_DEBUG_MSG - commands and their responses
34 * SMIC_DEBUG_STATES - state machine
36 #define SMIC_DEBUG_STATES 4
37 #define SMIC_DEBUG_MSG 2
38 #define SMIC_DEBUG_ENABLE 1
40 static int smic_debug = 1;
41 module_param(smic_debug, int, 0644);
42 MODULE_PARM_DESC(smic_debug, "debug bitmask, 1=enable, 2=messages, 4=states");
58 #define MAX_SMIC_READ_SIZE 80
59 #define MAX_SMIC_WRITE_SIZE 80
60 #define SMIC_MAX_ERROR_RETRIES 3
62 /* Timeouts in microseconds. */
63 #define SMIC_RETRY_TIMEOUT (2*USEC_PER_SEC)
65 /* SMIC Flags Register Bits */
66 #define SMIC_RX_DATA_READY 0x80
67 #define SMIC_TX_DATA_READY 0x40
70 * SMIC_SMI and SMIC_EVM_DATA_AVAIL are only used by
71 * a few systems, and then only by Systems Management
72 * Interrupts, not by the OS. Always ignore these bits.
76 #define SMIC_EVM_DATA_AVAIL 0x08
77 #define SMIC_SMS_DATA_AVAIL 0x04
78 #define SMIC_FLAG_BSY 0x01
80 /* SMIC Error Codes */
81 #define EC_NO_ERROR 0x00
82 #define EC_ABORTED 0x01
83 #define EC_ILLEGAL_CONTROL 0x02
84 #define EC_NO_RESPONSE 0x03
85 #define EC_ILLEGAL_COMMAND 0x04
86 #define EC_BUFFER_FULL 0x05
89 enum smic_states state;
91 unsigned char write_data[MAX_SMIC_WRITE_SIZE];
95 unsigned char read_data[MAX_SMIC_READ_SIZE];
98 unsigned int error_retries;
102 static unsigned int init_smic_data(struct si_sm_data *smic,
105 smic->state = SMIC_IDLE;
108 smic->write_count = 0;
109 smic->orig_write_count = 0;
111 smic->error_retries = 0;
113 smic->smic_timeout = SMIC_RETRY_TIMEOUT;
115 /* We use 3 bytes of I/O. */
119 static int start_smic_transaction(struct si_sm_data *smic,
120 unsigned char *data, unsigned int size)
125 return IPMI_REQ_LEN_INVALID_ERR;
126 if (size > MAX_SMIC_WRITE_SIZE)
127 return IPMI_REQ_LEN_EXCEEDED_ERR;
129 if ((smic->state != SMIC_IDLE) && (smic->state != SMIC_HOSED))
130 return IPMI_NOT_IN_MY_STATE_ERR;
132 if (smic_debug & SMIC_DEBUG_MSG) {
133 printk(KERN_DEBUG "start_smic_transaction -");
134 for (i = 0; i < size; i++)
135 printk(" %02x", (unsigned char) data[i]);
138 smic->error_retries = 0;
139 memcpy(smic->write_data, data, size);
140 smic->write_count = size;
141 smic->orig_write_count = size;
144 smic->state = SMIC_START_OP;
145 smic->smic_timeout = SMIC_RETRY_TIMEOUT;
149 static int smic_get_result(struct si_sm_data *smic,
150 unsigned char *data, unsigned int length)
154 if (smic_debug & SMIC_DEBUG_MSG) {
155 printk(KERN_DEBUG "smic_get result -");
156 for (i = 0; i < smic->read_pos; i++)
157 printk(" %02x", smic->read_data[i]);
160 if (length < smic->read_pos) {
161 smic->read_pos = length;
164 memcpy(data, smic->read_data, smic->read_pos);
166 if ((length >= 3) && (smic->read_pos < 3)) {
167 data[2] = IPMI_ERR_UNSPECIFIED;
170 if (smic->truncated) {
171 data[2] = IPMI_ERR_MSG_TRUNCATED;
174 return smic->read_pos;
177 static inline unsigned char read_smic_flags(struct si_sm_data *smic)
179 return smic->io->inputb(smic->io, 2);
182 static inline unsigned char read_smic_status(struct si_sm_data *smic)
184 return smic->io->inputb(smic->io, 1);
187 static inline unsigned char read_smic_data(struct si_sm_data *smic)
189 return smic->io->inputb(smic->io, 0);
192 static inline void write_smic_flags(struct si_sm_data *smic,
195 smic->io->outputb(smic->io, 2, flags);
198 static inline void write_smic_control(struct si_sm_data *smic,
199 unsigned char control)
201 smic->io->outputb(smic->io, 1, control);
204 static inline void write_si_sm_data(struct si_sm_data *smic,
207 smic->io->outputb(smic->io, 0, data);
210 static inline void start_error_recovery(struct si_sm_data *smic, char *reason)
212 (smic->error_retries)++;
213 if (smic->error_retries > SMIC_MAX_ERROR_RETRIES) {
214 if (smic_debug & SMIC_DEBUG_ENABLE)
216 "ipmi_smic_drv: smic hosed: %s\n", reason);
217 smic->state = SMIC_HOSED;
219 smic->write_count = smic->orig_write_count;
222 smic->state = SMIC_START_OP;
223 smic->smic_timeout = SMIC_RETRY_TIMEOUT;
227 static inline void write_next_byte(struct si_sm_data *smic)
229 write_si_sm_data(smic, smic->write_data[smic->write_pos]);
231 (smic->write_count)--;
234 static inline void read_next_byte(struct si_sm_data *smic)
236 if (smic->read_pos >= MAX_SMIC_READ_SIZE) {
237 read_smic_data(smic);
240 smic->read_data[smic->read_pos] = read_smic_data(smic);
245 /* SMIC Control/Status Code Components */
246 #define SMIC_GET_STATUS 0x00 /* Control form's name */
247 #define SMIC_READY 0x00 /* Status form's name */
248 #define SMIC_WR_START 0x01 /* Unified Control/Status names... */
249 #define SMIC_WR_NEXT 0x02
250 #define SMIC_WR_END 0x03
251 #define SMIC_RD_START 0x04
252 #define SMIC_RD_NEXT 0x05
253 #define SMIC_RD_END 0x06
254 #define SMIC_CODE_MASK 0x0f
256 #define SMIC_CONTROL 0x00
257 #define SMIC_STATUS 0x80
258 #define SMIC_CS_MASK 0x80
260 #define SMIC_SMS 0x40
261 #define SMIC_SMM 0x60
262 #define SMIC_STREAM_MASK 0x60
264 /* SMIC Control Codes */
265 #define SMIC_CC_SMS_GET_STATUS (SMIC_CONTROL|SMIC_SMS|SMIC_GET_STATUS)
266 #define SMIC_CC_SMS_WR_START (SMIC_CONTROL|SMIC_SMS|SMIC_WR_START)
267 #define SMIC_CC_SMS_WR_NEXT (SMIC_CONTROL|SMIC_SMS|SMIC_WR_NEXT)
268 #define SMIC_CC_SMS_WR_END (SMIC_CONTROL|SMIC_SMS|SMIC_WR_END)
269 #define SMIC_CC_SMS_RD_START (SMIC_CONTROL|SMIC_SMS|SMIC_RD_START)
270 #define SMIC_CC_SMS_RD_NEXT (SMIC_CONTROL|SMIC_SMS|SMIC_RD_NEXT)
271 #define SMIC_CC_SMS_RD_END (SMIC_CONTROL|SMIC_SMS|SMIC_RD_END)
273 #define SMIC_CC_SMM_GET_STATUS (SMIC_CONTROL|SMIC_SMM|SMIC_GET_STATUS)
274 #define SMIC_CC_SMM_WR_START (SMIC_CONTROL|SMIC_SMM|SMIC_WR_START)
275 #define SMIC_CC_SMM_WR_NEXT (SMIC_CONTROL|SMIC_SMM|SMIC_WR_NEXT)
276 #define SMIC_CC_SMM_WR_END (SMIC_CONTROL|SMIC_SMM|SMIC_WR_END)
277 #define SMIC_CC_SMM_RD_START (SMIC_CONTROL|SMIC_SMM|SMIC_RD_START)
278 #define SMIC_CC_SMM_RD_NEXT (SMIC_CONTROL|SMIC_SMM|SMIC_RD_NEXT)
279 #define SMIC_CC_SMM_RD_END (SMIC_CONTROL|SMIC_SMM|SMIC_RD_END)
281 /* SMIC Status Codes */
282 #define SMIC_SC_SMS_READY (SMIC_STATUS|SMIC_SMS|SMIC_READY)
283 #define SMIC_SC_SMS_WR_START (SMIC_STATUS|SMIC_SMS|SMIC_WR_START)
284 #define SMIC_SC_SMS_WR_NEXT (SMIC_STATUS|SMIC_SMS|SMIC_WR_NEXT)
285 #define SMIC_SC_SMS_WR_END (SMIC_STATUS|SMIC_SMS|SMIC_WR_END)
286 #define SMIC_SC_SMS_RD_START (SMIC_STATUS|SMIC_SMS|SMIC_RD_START)
287 #define SMIC_SC_SMS_RD_NEXT (SMIC_STATUS|SMIC_SMS|SMIC_RD_NEXT)
288 #define SMIC_SC_SMS_RD_END (SMIC_STATUS|SMIC_SMS|SMIC_RD_END)
290 #define SMIC_SC_SMM_READY (SMIC_STATUS|SMIC_SMM|SMIC_READY)
291 #define SMIC_SC_SMM_WR_START (SMIC_STATUS|SMIC_SMM|SMIC_WR_START)
292 #define SMIC_SC_SMM_WR_NEXT (SMIC_STATUS|SMIC_SMM|SMIC_WR_NEXT)
293 #define SMIC_SC_SMM_WR_END (SMIC_STATUS|SMIC_SMM|SMIC_WR_END)
294 #define SMIC_SC_SMM_RD_START (SMIC_STATUS|SMIC_SMM|SMIC_RD_START)
295 #define SMIC_SC_SMM_RD_NEXT (SMIC_STATUS|SMIC_SMM|SMIC_RD_NEXT)
296 #define SMIC_SC_SMM_RD_END (SMIC_STATUS|SMIC_SMM|SMIC_RD_END)
298 /* these are the control/status codes we actually use
299 SMIC_CC_SMS_GET_STATUS 0x40
300 SMIC_CC_SMS_WR_START 0x41
301 SMIC_CC_SMS_WR_NEXT 0x42
302 SMIC_CC_SMS_WR_END 0x43
303 SMIC_CC_SMS_RD_START 0x44
304 SMIC_CC_SMS_RD_NEXT 0x45
305 SMIC_CC_SMS_RD_END 0x46
307 SMIC_SC_SMS_READY 0xC0
308 SMIC_SC_SMS_WR_START 0xC1
309 SMIC_SC_SMS_WR_NEXT 0xC2
310 SMIC_SC_SMS_WR_END 0xC3
311 SMIC_SC_SMS_RD_START 0xC4
312 SMIC_SC_SMS_RD_NEXT 0xC5
313 SMIC_SC_SMS_RD_END 0xC6
316 static enum si_sm_result smic_event(struct si_sm_data *smic, long time)
318 unsigned char status;
322 if (smic->state == SMIC_HOSED) {
323 init_smic_data(smic, smic->io);
326 if (smic->state != SMIC_IDLE) {
327 if (smic_debug & SMIC_DEBUG_STATES)
329 "smic_event - smic->smic_timeout = %ld,"
331 smic->smic_timeout, time);
333 * FIXME: smic_event is sometimes called with time >
336 if (time < SMIC_RETRY_TIMEOUT) {
337 smic->smic_timeout -= time;
338 if (smic->smic_timeout < 0) {
339 start_error_recovery(smic, "smic timed out.");
340 return SI_SM_CALL_WITH_DELAY;
344 flags = read_smic_flags(smic);
345 if (flags & SMIC_FLAG_BSY)
346 return SI_SM_CALL_WITH_DELAY;
348 status = read_smic_status(smic);
349 if (smic_debug & SMIC_DEBUG_STATES)
351 "smic_event - state = %d, flags = 0x%02x,"
352 " status = 0x%02x\n",
353 smic->state, flags, status);
355 switch (smic->state) {
357 /* in IDLE we check for available messages */
358 if (flags & SMIC_SMS_DATA_AVAIL)
363 /* sanity check whether smic is really idle */
364 write_smic_control(smic, SMIC_CC_SMS_GET_STATUS);
365 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
366 smic->state = SMIC_OP_OK;
370 if (status != SMIC_SC_SMS_READY) {
371 /* this should not happen */
372 start_error_recovery(smic,
373 "state = SMIC_OP_OK,"
374 " status != SMIC_SC_SMS_READY");
375 return SI_SM_CALL_WITH_DELAY;
377 /* OK so far; smic is idle let us start ... */
378 write_smic_control(smic, SMIC_CC_SMS_WR_START);
379 write_next_byte(smic);
380 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
381 smic->state = SMIC_WRITE_START;
384 case SMIC_WRITE_START:
385 if (status != SMIC_SC_SMS_WR_START) {
386 start_error_recovery(smic,
387 "state = SMIC_WRITE_START, "
388 "status != SMIC_SC_SMS_WR_START");
389 return SI_SM_CALL_WITH_DELAY;
392 * we must not issue WR_(NEXT|END) unless
393 * TX_DATA_READY is set
395 if (flags & SMIC_TX_DATA_READY) {
396 if (smic->write_count == 1) {
398 write_smic_control(smic, SMIC_CC_SMS_WR_END);
399 smic->state = SMIC_WRITE_END;
401 write_smic_control(smic, SMIC_CC_SMS_WR_NEXT);
402 smic->state = SMIC_WRITE_NEXT;
404 write_next_byte(smic);
405 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
407 return SI_SM_CALL_WITH_DELAY;
410 case SMIC_WRITE_NEXT:
411 if (status != SMIC_SC_SMS_WR_NEXT) {
412 start_error_recovery(smic,
413 "state = SMIC_WRITE_NEXT, "
414 "status != SMIC_SC_SMS_WR_NEXT");
415 return SI_SM_CALL_WITH_DELAY;
417 /* this is the same code as in SMIC_WRITE_START */
418 if (flags & SMIC_TX_DATA_READY) {
419 if (smic->write_count == 1) {
420 write_smic_control(smic, SMIC_CC_SMS_WR_END);
421 smic->state = SMIC_WRITE_END;
423 write_smic_control(smic, SMIC_CC_SMS_WR_NEXT);
424 smic->state = SMIC_WRITE_NEXT;
426 write_next_byte(smic);
427 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
429 return SI_SM_CALL_WITH_DELAY;
433 if (status != SMIC_SC_SMS_WR_END) {
434 start_error_recovery(smic,
435 "state = SMIC_WRITE_END, "
436 "status != SMIC_SC_SMS_WR_END");
437 return SI_SM_CALL_WITH_DELAY;
439 /* data register holds an error code */
440 data = read_smic_data(smic);
442 if (smic_debug & SMIC_DEBUG_ENABLE)
444 "SMIC_WRITE_END: data = %02x\n", data);
445 start_error_recovery(smic,
446 "state = SMIC_WRITE_END, "
448 return SI_SM_CALL_WITH_DELAY;
450 smic->state = SMIC_WRITE2READ;
453 case SMIC_WRITE2READ:
455 * we must wait for RX_DATA_READY to be set before we
458 if (flags & SMIC_RX_DATA_READY) {
459 write_smic_control(smic, SMIC_CC_SMS_RD_START);
460 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
461 smic->state = SMIC_READ_START;
463 return SI_SM_CALL_WITH_DELAY;
466 case SMIC_READ_START:
467 if (status != SMIC_SC_SMS_RD_START) {
468 start_error_recovery(smic,
469 "state = SMIC_READ_START, "
470 "status != SMIC_SC_SMS_RD_START");
471 return SI_SM_CALL_WITH_DELAY;
473 if (flags & SMIC_RX_DATA_READY) {
474 read_next_byte(smic);
475 write_smic_control(smic, SMIC_CC_SMS_RD_NEXT);
476 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
477 smic->state = SMIC_READ_NEXT;
479 return SI_SM_CALL_WITH_DELAY;
485 * smic tells us that this is the last byte to be read
488 case SMIC_SC_SMS_RD_END:
489 read_next_byte(smic);
490 write_smic_control(smic, SMIC_CC_SMS_RD_END);
491 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
492 smic->state = SMIC_READ_END;
494 case SMIC_SC_SMS_RD_NEXT:
495 if (flags & SMIC_RX_DATA_READY) {
496 read_next_byte(smic);
497 write_smic_control(smic, SMIC_CC_SMS_RD_NEXT);
498 write_smic_flags(smic, flags | SMIC_FLAG_BSY);
499 smic->state = SMIC_READ_NEXT;
501 return SI_SM_CALL_WITH_DELAY;
504 start_error_recovery(
506 "state = SMIC_READ_NEXT, "
507 "status != SMIC_SC_SMS_RD_(NEXT|END)");
508 return SI_SM_CALL_WITH_DELAY;
513 if (status != SMIC_SC_SMS_READY) {
514 start_error_recovery(smic,
515 "state = SMIC_READ_END, "
516 "status != SMIC_SC_SMS_READY");
517 return SI_SM_CALL_WITH_DELAY;
519 data = read_smic_data(smic);
520 /* data register holds an error code */
522 if (smic_debug & SMIC_DEBUG_ENABLE)
524 "SMIC_READ_END: data = %02x\n", data);
525 start_error_recovery(smic,
526 "state = SMIC_READ_END, "
528 return SI_SM_CALL_WITH_DELAY;
530 smic->state = SMIC_IDLE;
531 return SI_SM_TRANSACTION_COMPLETE;
535 init_smic_data(smic, smic->io);
539 if (smic_debug & SMIC_DEBUG_ENABLE) {
540 printk(KERN_DEBUG "smic->state = %d\n", smic->state);
541 start_error_recovery(smic, "state = UNKNOWN");
542 return SI_SM_CALL_WITH_DELAY;
545 smic->smic_timeout = SMIC_RETRY_TIMEOUT;
546 return SI_SM_CALL_WITHOUT_DELAY;
549 static int smic_detect(struct si_sm_data *smic)
552 * It's impossible for the SMIC fnags register to be all 1's,
553 * (assuming a properly functioning, self-initialized BMC)
554 * but that's what you get from reading a bogus address, so we
557 if (read_smic_flags(smic) == 0xff)
563 static void smic_cleanup(struct si_sm_data *kcs)
567 static int smic_size(void)
569 return sizeof(struct si_sm_data);
572 const struct si_sm_handlers smic_smi_handlers = {
573 .init_data = init_smic_data,
574 .start_transaction = start_smic_transaction,
575 .get_result = smic_get_result,
577 .detect = smic_detect,
578 .cleanup = smic_cleanup,