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 #define DEBUG /* So dev_dbg() is always available. */
26 #include <linux/kernel.h> /* For printk. */
27 #include <linux/string.h>
28 #include <linux/module.h>
29 #include <linux/moduleparam.h>
30 #include <linux/ipmi_msgdefs.h> /* for completion codes */
31 #include "ipmi_si_sm.h"
33 /* smic_debug is a bit-field
34 * SMIC_DEBUG_ENABLE - turned on for now
35 * SMIC_DEBUG_MSG - commands and their responses
36 * SMIC_DEBUG_STATES - state machine
38 #define SMIC_DEBUG_STATES 4
39 #define SMIC_DEBUG_MSG 2
40 #define SMIC_DEBUG_ENABLE 1
42 static int smic_debug
= 1;
43 module_param(smic_debug
, int, 0644);
44 MODULE_PARM_DESC(smic_debug
, "debug bitmask, 1=enable, 2=messages, 4=states");
60 #define MAX_SMIC_READ_SIZE 80
61 #define MAX_SMIC_WRITE_SIZE 80
62 #define SMIC_MAX_ERROR_RETRIES 3
64 /* Timeouts in microseconds. */
65 #define SMIC_RETRY_TIMEOUT (2*USEC_PER_SEC)
67 /* SMIC Flags Register Bits */
68 #define SMIC_RX_DATA_READY 0x80
69 #define SMIC_TX_DATA_READY 0x40
72 * SMIC_SMI and SMIC_EVM_DATA_AVAIL are only used by
73 * a few systems, and then only by Systems Management
74 * Interrupts, not by the OS. Always ignore these bits.
78 #define SMIC_EVM_DATA_AVAIL 0x08
79 #define SMIC_SMS_DATA_AVAIL 0x04
80 #define SMIC_FLAG_BSY 0x01
82 /* SMIC Error Codes */
83 #define EC_NO_ERROR 0x00
84 #define EC_ABORTED 0x01
85 #define EC_ILLEGAL_CONTROL 0x02
86 #define EC_NO_RESPONSE 0x03
87 #define EC_ILLEGAL_COMMAND 0x04
88 #define EC_BUFFER_FULL 0x05
91 enum smic_states state
;
93 unsigned char write_data
[MAX_SMIC_WRITE_SIZE
];
97 unsigned char read_data
[MAX_SMIC_READ_SIZE
];
100 unsigned int error_retries
;
104 static unsigned int init_smic_data(struct si_sm_data
*smic
,
107 smic
->state
= SMIC_IDLE
;
110 smic
->write_count
= 0;
111 smic
->orig_write_count
= 0;
113 smic
->error_retries
= 0;
115 smic
->smic_timeout
= SMIC_RETRY_TIMEOUT
;
117 /* We use 3 bytes of I/O. */
121 static int start_smic_transaction(struct si_sm_data
*smic
,
122 unsigned char *data
, unsigned int size
)
127 return IPMI_REQ_LEN_INVALID_ERR
;
128 if (size
> MAX_SMIC_WRITE_SIZE
)
129 return IPMI_REQ_LEN_EXCEEDED_ERR
;
131 if ((smic
->state
!= SMIC_IDLE
) && (smic
->state
!= SMIC_HOSED
)) {
132 dev_warn(smic
->io
->dev
,
133 "SMIC in invalid state %d\n", smic
->state
);
134 return IPMI_NOT_IN_MY_STATE_ERR
;
137 if (smic_debug
& SMIC_DEBUG_MSG
) {
138 dev_dbg(smic
->io
->dev
, "%s -", __func__
);
139 for (i
= 0; i
< size
; i
++)
140 pr_cont(" %02x", data
[i
]);
143 smic
->error_retries
= 0;
144 memcpy(smic
->write_data
, data
, size
);
145 smic
->write_count
= size
;
146 smic
->orig_write_count
= size
;
149 smic
->state
= SMIC_START_OP
;
150 smic
->smic_timeout
= SMIC_RETRY_TIMEOUT
;
154 static int smic_get_result(struct si_sm_data
*smic
,
155 unsigned char *data
, unsigned int length
)
159 if (smic_debug
& SMIC_DEBUG_MSG
) {
160 dev_dbg(smic
->io
->dev
, "smic_get result -");
161 for (i
= 0; i
< smic
->read_pos
; i
++)
162 pr_cont(" %02x", smic
->read_data
[i
]);
165 if (length
< smic
->read_pos
) {
166 smic
->read_pos
= length
;
169 memcpy(data
, smic
->read_data
, smic
->read_pos
);
171 if ((length
>= 3) && (smic
->read_pos
< 3)) {
172 data
[2] = IPMI_ERR_UNSPECIFIED
;
175 if (smic
->truncated
) {
176 data
[2] = IPMI_ERR_MSG_TRUNCATED
;
179 return smic
->read_pos
;
182 static inline unsigned char read_smic_flags(struct si_sm_data
*smic
)
184 return smic
->io
->inputb(smic
->io
, 2);
187 static inline unsigned char read_smic_status(struct si_sm_data
*smic
)
189 return smic
->io
->inputb(smic
->io
, 1);
192 static inline unsigned char read_smic_data(struct si_sm_data
*smic
)
194 return smic
->io
->inputb(smic
->io
, 0);
197 static inline void write_smic_flags(struct si_sm_data
*smic
,
200 smic
->io
->outputb(smic
->io
, 2, flags
);
203 static inline void write_smic_control(struct si_sm_data
*smic
,
204 unsigned char control
)
206 smic
->io
->outputb(smic
->io
, 1, control
);
209 static inline void write_si_sm_data(struct si_sm_data
*smic
,
212 smic
->io
->outputb(smic
->io
, 0, data
);
215 static inline void start_error_recovery(struct si_sm_data
*smic
, char *reason
)
217 (smic
->error_retries
)++;
218 if (smic
->error_retries
> SMIC_MAX_ERROR_RETRIES
) {
219 if (smic_debug
& SMIC_DEBUG_ENABLE
)
220 pr_warn("ipmi_smic_drv: smic hosed: %s\n", reason
);
221 smic
->state
= SMIC_HOSED
;
223 smic
->write_count
= smic
->orig_write_count
;
226 smic
->state
= SMIC_START_OP
;
227 smic
->smic_timeout
= SMIC_RETRY_TIMEOUT
;
231 static inline void write_next_byte(struct si_sm_data
*smic
)
233 write_si_sm_data(smic
, smic
->write_data
[smic
->write_pos
]);
235 (smic
->write_count
)--;
238 static inline void read_next_byte(struct si_sm_data
*smic
)
240 if (smic
->read_pos
>= MAX_SMIC_READ_SIZE
) {
241 read_smic_data(smic
);
244 smic
->read_data
[smic
->read_pos
] = read_smic_data(smic
);
249 /* SMIC Control/Status Code Components */
250 #define SMIC_GET_STATUS 0x00 /* Control form's name */
251 #define SMIC_READY 0x00 /* Status form's name */
252 #define SMIC_WR_START 0x01 /* Unified Control/Status names... */
253 #define SMIC_WR_NEXT 0x02
254 #define SMIC_WR_END 0x03
255 #define SMIC_RD_START 0x04
256 #define SMIC_RD_NEXT 0x05
257 #define SMIC_RD_END 0x06
258 #define SMIC_CODE_MASK 0x0f
260 #define SMIC_CONTROL 0x00
261 #define SMIC_STATUS 0x80
262 #define SMIC_CS_MASK 0x80
264 #define SMIC_SMS 0x40
265 #define SMIC_SMM 0x60
266 #define SMIC_STREAM_MASK 0x60
268 /* SMIC Control Codes */
269 #define SMIC_CC_SMS_GET_STATUS (SMIC_CONTROL|SMIC_SMS|SMIC_GET_STATUS)
270 #define SMIC_CC_SMS_WR_START (SMIC_CONTROL|SMIC_SMS|SMIC_WR_START)
271 #define SMIC_CC_SMS_WR_NEXT (SMIC_CONTROL|SMIC_SMS|SMIC_WR_NEXT)
272 #define SMIC_CC_SMS_WR_END (SMIC_CONTROL|SMIC_SMS|SMIC_WR_END)
273 #define SMIC_CC_SMS_RD_START (SMIC_CONTROL|SMIC_SMS|SMIC_RD_START)
274 #define SMIC_CC_SMS_RD_NEXT (SMIC_CONTROL|SMIC_SMS|SMIC_RD_NEXT)
275 #define SMIC_CC_SMS_RD_END (SMIC_CONTROL|SMIC_SMS|SMIC_RD_END)
277 #define SMIC_CC_SMM_GET_STATUS (SMIC_CONTROL|SMIC_SMM|SMIC_GET_STATUS)
278 #define SMIC_CC_SMM_WR_START (SMIC_CONTROL|SMIC_SMM|SMIC_WR_START)
279 #define SMIC_CC_SMM_WR_NEXT (SMIC_CONTROL|SMIC_SMM|SMIC_WR_NEXT)
280 #define SMIC_CC_SMM_WR_END (SMIC_CONTROL|SMIC_SMM|SMIC_WR_END)
281 #define SMIC_CC_SMM_RD_START (SMIC_CONTROL|SMIC_SMM|SMIC_RD_START)
282 #define SMIC_CC_SMM_RD_NEXT (SMIC_CONTROL|SMIC_SMM|SMIC_RD_NEXT)
283 #define SMIC_CC_SMM_RD_END (SMIC_CONTROL|SMIC_SMM|SMIC_RD_END)
285 /* SMIC Status Codes */
286 #define SMIC_SC_SMS_READY (SMIC_STATUS|SMIC_SMS|SMIC_READY)
287 #define SMIC_SC_SMS_WR_START (SMIC_STATUS|SMIC_SMS|SMIC_WR_START)
288 #define SMIC_SC_SMS_WR_NEXT (SMIC_STATUS|SMIC_SMS|SMIC_WR_NEXT)
289 #define SMIC_SC_SMS_WR_END (SMIC_STATUS|SMIC_SMS|SMIC_WR_END)
290 #define SMIC_SC_SMS_RD_START (SMIC_STATUS|SMIC_SMS|SMIC_RD_START)
291 #define SMIC_SC_SMS_RD_NEXT (SMIC_STATUS|SMIC_SMS|SMIC_RD_NEXT)
292 #define SMIC_SC_SMS_RD_END (SMIC_STATUS|SMIC_SMS|SMIC_RD_END)
294 #define SMIC_SC_SMM_READY (SMIC_STATUS|SMIC_SMM|SMIC_READY)
295 #define SMIC_SC_SMM_WR_START (SMIC_STATUS|SMIC_SMM|SMIC_WR_START)
296 #define SMIC_SC_SMM_WR_NEXT (SMIC_STATUS|SMIC_SMM|SMIC_WR_NEXT)
297 #define SMIC_SC_SMM_WR_END (SMIC_STATUS|SMIC_SMM|SMIC_WR_END)
298 #define SMIC_SC_SMM_RD_START (SMIC_STATUS|SMIC_SMM|SMIC_RD_START)
299 #define SMIC_SC_SMM_RD_NEXT (SMIC_STATUS|SMIC_SMM|SMIC_RD_NEXT)
300 #define SMIC_SC_SMM_RD_END (SMIC_STATUS|SMIC_SMM|SMIC_RD_END)
302 /* these are the control/status codes we actually use
303 SMIC_CC_SMS_GET_STATUS 0x40
304 SMIC_CC_SMS_WR_START 0x41
305 SMIC_CC_SMS_WR_NEXT 0x42
306 SMIC_CC_SMS_WR_END 0x43
307 SMIC_CC_SMS_RD_START 0x44
308 SMIC_CC_SMS_RD_NEXT 0x45
309 SMIC_CC_SMS_RD_END 0x46
311 SMIC_SC_SMS_READY 0xC0
312 SMIC_SC_SMS_WR_START 0xC1
313 SMIC_SC_SMS_WR_NEXT 0xC2
314 SMIC_SC_SMS_WR_END 0xC3
315 SMIC_SC_SMS_RD_START 0xC4
316 SMIC_SC_SMS_RD_NEXT 0xC5
317 SMIC_SC_SMS_RD_END 0xC6
320 static enum si_sm_result
smic_event(struct si_sm_data
*smic
, long time
)
322 unsigned char status
;
326 if (smic
->state
== SMIC_HOSED
) {
327 init_smic_data(smic
, smic
->io
);
330 if (smic
->state
!= SMIC_IDLE
) {
331 if (smic_debug
& SMIC_DEBUG_STATES
)
332 dev_dbg(smic
->io
->dev
,
333 "%s - smic->smic_timeout = %ld, time = %ld\n",
334 __func__
, smic
->smic_timeout
, time
);
336 * FIXME: smic_event is sometimes called with time >
339 if (time
< SMIC_RETRY_TIMEOUT
) {
340 smic
->smic_timeout
-= time
;
341 if (smic
->smic_timeout
< 0) {
342 start_error_recovery(smic
, "smic timed out.");
343 return SI_SM_CALL_WITH_DELAY
;
347 flags
= read_smic_flags(smic
);
348 if (flags
& SMIC_FLAG_BSY
)
349 return SI_SM_CALL_WITH_DELAY
;
351 status
= read_smic_status(smic
);
352 if (smic_debug
& SMIC_DEBUG_STATES
)
353 dev_dbg(smic
->io
->dev
,
354 "%s - state = %d, flags = 0x%02x, status = 0x%02x\n",
355 __func__
, smic
->state
, flags
, status
);
357 switch (smic
->state
) {
359 /* in IDLE we check for available messages */
360 if (flags
& SMIC_SMS_DATA_AVAIL
)
365 /* sanity check whether smic is really idle */
366 write_smic_control(smic
, SMIC_CC_SMS_GET_STATUS
);
367 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
368 smic
->state
= SMIC_OP_OK
;
372 if (status
!= SMIC_SC_SMS_READY
) {
373 /* this should not happen */
374 start_error_recovery(smic
,
375 "state = SMIC_OP_OK,"
376 " status != SMIC_SC_SMS_READY");
377 return SI_SM_CALL_WITH_DELAY
;
379 /* OK so far; smic is idle let us start ... */
380 write_smic_control(smic
, SMIC_CC_SMS_WR_START
);
381 write_next_byte(smic
);
382 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
383 smic
->state
= SMIC_WRITE_START
;
386 case SMIC_WRITE_START
:
387 if (status
!= SMIC_SC_SMS_WR_START
) {
388 start_error_recovery(smic
,
389 "state = SMIC_WRITE_START, "
390 "status != SMIC_SC_SMS_WR_START");
391 return SI_SM_CALL_WITH_DELAY
;
394 * we must not issue WR_(NEXT|END) unless
395 * TX_DATA_READY is set
397 if (flags
& SMIC_TX_DATA_READY
) {
398 if (smic
->write_count
== 1) {
400 write_smic_control(smic
, SMIC_CC_SMS_WR_END
);
401 smic
->state
= SMIC_WRITE_END
;
403 write_smic_control(smic
, SMIC_CC_SMS_WR_NEXT
);
404 smic
->state
= SMIC_WRITE_NEXT
;
406 write_next_byte(smic
);
407 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
409 return SI_SM_CALL_WITH_DELAY
;
412 case SMIC_WRITE_NEXT
:
413 if (status
!= SMIC_SC_SMS_WR_NEXT
) {
414 start_error_recovery(smic
,
415 "state = SMIC_WRITE_NEXT, "
416 "status != SMIC_SC_SMS_WR_NEXT");
417 return SI_SM_CALL_WITH_DELAY
;
419 /* this is the same code as in SMIC_WRITE_START */
420 if (flags
& SMIC_TX_DATA_READY
) {
421 if (smic
->write_count
== 1) {
422 write_smic_control(smic
, SMIC_CC_SMS_WR_END
);
423 smic
->state
= SMIC_WRITE_END
;
425 write_smic_control(smic
, SMIC_CC_SMS_WR_NEXT
);
426 smic
->state
= SMIC_WRITE_NEXT
;
428 write_next_byte(smic
);
429 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
431 return SI_SM_CALL_WITH_DELAY
;
435 if (status
!= SMIC_SC_SMS_WR_END
) {
436 start_error_recovery(smic
,
437 "state = SMIC_WRITE_END, "
438 "status != SMIC_SC_SMS_WR_END");
439 return SI_SM_CALL_WITH_DELAY
;
441 /* data register holds an error code */
442 data
= read_smic_data(smic
);
444 if (smic_debug
& SMIC_DEBUG_ENABLE
)
445 dev_dbg(smic
->io
->dev
,
446 "SMIC_WRITE_END: data = %02x\n",
448 start_error_recovery(smic
,
449 "state = SMIC_WRITE_END, "
451 return SI_SM_CALL_WITH_DELAY
;
453 smic
->state
= SMIC_WRITE2READ
;
456 case SMIC_WRITE2READ
:
458 * we must wait for RX_DATA_READY to be set before we
461 if (flags
& SMIC_RX_DATA_READY
) {
462 write_smic_control(smic
, SMIC_CC_SMS_RD_START
);
463 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
464 smic
->state
= SMIC_READ_START
;
466 return SI_SM_CALL_WITH_DELAY
;
469 case SMIC_READ_START
:
470 if (status
!= SMIC_SC_SMS_RD_START
) {
471 start_error_recovery(smic
,
472 "state = SMIC_READ_START, "
473 "status != SMIC_SC_SMS_RD_START");
474 return SI_SM_CALL_WITH_DELAY
;
476 if (flags
& SMIC_RX_DATA_READY
) {
477 read_next_byte(smic
);
478 write_smic_control(smic
, SMIC_CC_SMS_RD_NEXT
);
479 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
480 smic
->state
= SMIC_READ_NEXT
;
482 return SI_SM_CALL_WITH_DELAY
;
488 * smic tells us that this is the last byte to be read
491 case SMIC_SC_SMS_RD_END
:
492 read_next_byte(smic
);
493 write_smic_control(smic
, SMIC_CC_SMS_RD_END
);
494 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
495 smic
->state
= SMIC_READ_END
;
497 case SMIC_SC_SMS_RD_NEXT
:
498 if (flags
& SMIC_RX_DATA_READY
) {
499 read_next_byte(smic
);
500 write_smic_control(smic
, SMIC_CC_SMS_RD_NEXT
);
501 write_smic_flags(smic
, flags
| SMIC_FLAG_BSY
);
502 smic
->state
= SMIC_READ_NEXT
;
504 return SI_SM_CALL_WITH_DELAY
;
507 start_error_recovery(
509 "state = SMIC_READ_NEXT, "
510 "status != SMIC_SC_SMS_RD_(NEXT|END)");
511 return SI_SM_CALL_WITH_DELAY
;
516 if (status
!= SMIC_SC_SMS_READY
) {
517 start_error_recovery(smic
,
518 "state = SMIC_READ_END, "
519 "status != SMIC_SC_SMS_READY");
520 return SI_SM_CALL_WITH_DELAY
;
522 data
= read_smic_data(smic
);
523 /* data register holds an error code */
525 if (smic_debug
& SMIC_DEBUG_ENABLE
)
526 dev_dbg(smic
->io
->dev
,
527 "SMIC_READ_END: data = %02x\n",
529 start_error_recovery(smic
,
530 "state = SMIC_READ_END, "
532 return SI_SM_CALL_WITH_DELAY
;
534 smic
->state
= SMIC_IDLE
;
535 return SI_SM_TRANSACTION_COMPLETE
;
539 init_smic_data(smic
, smic
->io
);
543 if (smic_debug
& SMIC_DEBUG_ENABLE
) {
544 dev_dbg(smic
->io
->dev
,
545 "smic->state = %d\n", smic
->state
);
546 start_error_recovery(smic
, "state = UNKNOWN");
547 return SI_SM_CALL_WITH_DELAY
;
550 smic
->smic_timeout
= SMIC_RETRY_TIMEOUT
;
551 return SI_SM_CALL_WITHOUT_DELAY
;
554 static int smic_detect(struct si_sm_data
*smic
)
557 * It's impossible for the SMIC fnags register to be all 1's,
558 * (assuming a properly functioning, self-initialized BMC)
559 * but that's what you get from reading a bogus address, so we
562 if (read_smic_flags(smic
) == 0xff)
568 static void smic_cleanup(struct si_sm_data
*kcs
)
572 static int smic_size(void)
574 return sizeof(struct si_sm_data
);
577 const struct si_sm_handlers smic_smi_handlers
= {
578 .init_data
= init_smic_data
,
579 .start_transaction
= start_smic_transaction
,
580 .get_result
= smic_get_result
,
582 .detect
= smic_detect
,
583 .cleanup
= smic_cleanup
,