4 * The interface to the IPMI driver for SMBus access to a SMBus
5 * compliant device. Called SSIF by the IPMI spec.
7 * Author: Intel Corporation
8 * Todd Davis <todd.c.davis@intel.com>
10 * Rewritten by Corey Minyard <minyard@acm.org> to support the
11 * non-blocking I2C interface, add support for multi-part
12 * transactions, add PEC support, and general clenaup.
14 * Copyright 2003 Intel Corporation
15 * Copyright 2005 MontaVista Software
17 * This program is free software; you can redistribute it and/or modify it
18 * under the terms of the GNU General Public License as published by the
19 * Free Software Foundation; either version 2 of the License, or (at your
20 * option) any later version.
24 * This file holds the "policy" for the interface to the SSIF state
25 * machine. It does the configuration, handles timers and interrupts,
26 * and drives the real SSIF state machine.
30 * TODO: Figure out how to use SMB alerts. This will require a new
31 * interface into the I2C driver, I believe.
34 #if defined(MODVERSIONS)
35 #include <linux/modversions.h>
38 #include <linux/module.h>
39 #include <linux/moduleparam.h>
40 #include <linux/sched.h>
41 #include <linux/seq_file.h>
42 #include <linux/timer.h>
43 #include <linux/delay.h>
44 #include <linux/errno.h>
45 #include <linux/spinlock.h>
46 #include <linux/slab.h>
47 #include <linux/list.h>
48 #include <linux/i2c.h>
49 #include <linux/ipmi_smi.h>
50 #include <linux/init.h>
51 #include <linux/dmi.h>
52 #include <linux/kthread.h>
53 #include <linux/acpi.h>
54 #include <linux/ctype.h>
55 #include <linux/time64.h>
57 #define PFX "ipmi_ssif: "
58 #define DEVICE_NAME "ipmi_ssif"
60 #define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_CMD 0x57
62 #define SSIF_IPMI_REQUEST 2
63 #define SSIF_IPMI_MULTI_PART_REQUEST_START 6
64 #define SSIF_IPMI_MULTI_PART_REQUEST_MIDDLE 7
65 #define SSIF_IPMI_RESPONSE 3
66 #define SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE 9
68 /* ssif_debug is a bit-field
69 * SSIF_DEBUG_MSG - commands and their responses
70 * SSIF_DEBUG_STATES - message states
71 * SSIF_DEBUG_TIMING - Measure times between events in the driver
73 #define SSIF_DEBUG_TIMING 4
74 #define SSIF_DEBUG_STATE 2
75 #define SSIF_DEBUG_MSG 1
76 #define SSIF_NODEBUG 0
77 #define SSIF_DEFAULT_DEBUG (SSIF_NODEBUG)
82 #define SSIF_MSG_USEC 20000 /* 20ms between message tries. */
83 #define SSIF_MSG_PART_USEC 5000 /* 5ms for a message part */
85 /* How many times to we retry sending/receiving the message. */
86 #define SSIF_SEND_RETRIES 5
87 #define SSIF_RECV_RETRIES 250
89 #define SSIF_MSG_MSEC (SSIF_MSG_USEC / 1000)
90 #define SSIF_MSG_JIFFIES ((SSIF_MSG_USEC * 1000) / TICK_NSEC)
91 #define SSIF_MSG_PART_JIFFIES ((SSIF_MSG_PART_USEC * 1000) / TICK_NSEC)
93 enum ssif_intf_state {
98 SSIF_GETTING_MESSAGES,
99 /* FIXME - add watchdog stuff. */
102 #define SSIF_IDLE(ssif) ((ssif)->ssif_state == SSIF_NORMAL \
103 && (ssif)->curr_msg == NULL)
106 * Indexes into stats[] in ssif_info below.
108 enum ssif_stat_indexes {
109 /* Number of total messages sent. */
110 SSIF_STAT_sent_messages = 0,
113 * Number of message parts sent. Messages may be broken into
114 * parts if they are long.
116 SSIF_STAT_sent_messages_parts,
119 * Number of time a message was retried.
121 SSIF_STAT_send_retries,
124 * Number of times the send of a message failed.
126 SSIF_STAT_send_errors,
129 * Number of message responses received.
131 SSIF_STAT_received_messages,
134 * Number of message fragments received.
136 SSIF_STAT_received_message_parts,
139 * Number of times the receive of a message was retried.
141 SSIF_STAT_receive_retries,
144 * Number of errors receiving messages.
146 SSIF_STAT_receive_errors,
149 * Number of times a flag fetch was requested.
151 SSIF_STAT_flag_fetches,
154 * Number of times the hardware didn't follow the state machine.
159 * Number of received events.
163 /* Number of asyncronous messages received. */
164 SSIF_STAT_incoming_messages,
166 /* Number of watchdog pretimeouts. */
167 SSIF_STAT_watchdog_pretimeouts,
169 /* Number of alers received. */
172 /* Always add statistics before this value, it must be last. */
176 struct ssif_addr_info {
178 struct i2c_board_info binfo;
182 enum ipmi_addr_src addr_src;
183 union ipmi_smi_info_union addr_info;
185 struct mutex clients_mutex;
186 struct list_head clients;
188 struct list_head link;
193 typedef void (*ssif_i2c_done)(struct ssif_info *ssif_info, int result,
194 unsigned char *data, unsigned int len);
200 struct ipmi_smi_msg *waiting_msg;
201 struct ipmi_smi_msg *curr_msg;
202 enum ssif_intf_state ssif_state;
203 unsigned long ssif_debug;
205 struct ipmi_smi_handlers handlers;
207 enum ipmi_addr_src addr_source; /* ACPI, PCI, SMBIOS, hardcode, etc. */
208 union ipmi_smi_info_union addr_info;
211 * Flags from the last GET_MSG_FLAGS command, used when an ATTN
212 * is set to hold the flags until we are done handling everything
215 #define RECEIVE_MSG_AVAIL 0x01
216 #define EVENT_MSG_BUFFER_FULL 0x02
217 #define WDT_PRE_TIMEOUT_INT 0x08
218 unsigned char msg_flags;
221 bool has_event_buffer;
225 * Used to tell what we should do with alerts. If we are
226 * waiting on a response, read the data immediately.
232 * If set to true, this will request events the next time the
233 * state machine is idle.
238 * If set to true, this will request flags the next time the
239 * state machine is idle.
244 * Used to perform timer operations when run-to-completion
245 * mode is on. This is a countdown timer.
249 /* Used for sending/receiving data. +1 for the length. */
250 unsigned char data[IPMI_MAX_MSG_LENGTH + 1];
251 unsigned int data_len;
253 /* Temp receive buffer, gets copied into data. */
254 unsigned char recv[I2C_SMBUS_BLOCK_MAX];
256 struct i2c_client *client;
257 ssif_i2c_done done_handler;
259 /* Thread interface handling */
260 struct task_struct *thread;
261 struct completion wake_thread;
265 unsigned char *i2c_data;
266 unsigned int i2c_size;
268 /* From the device id response. */
269 struct ipmi_device_id device_id;
271 struct timer_list retry_timer;
274 /* Info from SSIF cmd */
275 unsigned char max_xmit_msg_size;
276 unsigned char max_recv_msg_size;
277 unsigned int multi_support;
280 #define SSIF_NO_MULTI 0
281 #define SSIF_MULTI_2_PART 1
282 #define SSIF_MULTI_n_PART 2
283 unsigned char *multi_data;
284 unsigned int multi_len;
285 unsigned int multi_pos;
287 atomic_t stats[SSIF_NUM_STATS];
290 #define ssif_inc_stat(ssif, stat) \
291 atomic_inc(&(ssif)->stats[SSIF_STAT_ ## stat])
292 #define ssif_get_stat(ssif, stat) \
293 ((unsigned int) atomic_read(&(ssif)->stats[SSIF_STAT_ ## stat]))
295 static bool initialized;
297 static atomic_t next_intf = ATOMIC_INIT(0);
299 static void return_hosed_msg(struct ssif_info *ssif_info,
300 struct ipmi_smi_msg *msg);
301 static void start_next_msg(struct ssif_info *ssif_info, unsigned long *flags);
302 static int start_send(struct ssif_info *ssif_info,
306 static unsigned long *ipmi_ssif_lock_cond(struct ssif_info *ssif_info,
307 unsigned long *flags)
309 spin_lock_irqsave(&ssif_info->lock, *flags);
313 static void ipmi_ssif_unlock_cond(struct ssif_info *ssif_info,
314 unsigned long *flags)
316 spin_unlock_irqrestore(&ssif_info->lock, *flags);
319 static void deliver_recv_msg(struct ssif_info *ssif_info,
320 struct ipmi_smi_msg *msg)
322 ipmi_smi_t intf = ssif_info->intf;
325 ipmi_free_smi_msg(msg);
326 } else if (msg->rsp_size < 0) {
327 return_hosed_msg(ssif_info, msg);
329 "Malformed message in deliver_recv_msg: rsp_size = %d\n",
332 ipmi_smi_msg_received(intf, msg);
336 static void return_hosed_msg(struct ssif_info *ssif_info,
337 struct ipmi_smi_msg *msg)
339 ssif_inc_stat(ssif_info, hosed);
341 /* Make it a response */
342 msg->rsp[0] = msg->data[0] | 4;
343 msg->rsp[1] = msg->data[1];
344 msg->rsp[2] = 0xFF; /* Unknown error. */
347 deliver_recv_msg(ssif_info, msg);
351 * Must be called with the message lock held. This will release the
352 * message lock. Note that the caller will check SSIF_IDLE and start a
353 * new operation, so there is no need to check for new messages to
356 static void start_clear_flags(struct ssif_info *ssif_info, unsigned long *flags)
358 unsigned char msg[3];
360 ssif_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
361 ssif_info->ssif_state = SSIF_CLEARING_FLAGS;
362 ipmi_ssif_unlock_cond(ssif_info, flags);
364 /* Make sure the watchdog pre-timeout flag is not set at startup. */
365 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
366 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
367 msg[2] = WDT_PRE_TIMEOUT_INT;
369 if (start_send(ssif_info, msg, 3) != 0) {
370 /* Error, just go to normal state. */
371 ssif_info->ssif_state = SSIF_NORMAL;
375 static void start_flag_fetch(struct ssif_info *ssif_info, unsigned long *flags)
379 ssif_info->req_flags = false;
380 ssif_info->ssif_state = SSIF_GETTING_FLAGS;
381 ipmi_ssif_unlock_cond(ssif_info, flags);
383 mb[0] = (IPMI_NETFN_APP_REQUEST << 2);
384 mb[1] = IPMI_GET_MSG_FLAGS_CMD;
385 if (start_send(ssif_info, mb, 2) != 0)
386 ssif_info->ssif_state = SSIF_NORMAL;
389 static void check_start_send(struct ssif_info *ssif_info, unsigned long *flags,
390 struct ipmi_smi_msg *msg)
392 if (start_send(ssif_info, msg->data, msg->data_size) != 0) {
393 unsigned long oflags;
395 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
396 ssif_info->curr_msg = NULL;
397 ssif_info->ssif_state = SSIF_NORMAL;
398 ipmi_ssif_unlock_cond(ssif_info, flags);
399 ipmi_free_smi_msg(msg);
403 static void start_event_fetch(struct ssif_info *ssif_info, unsigned long *flags)
405 struct ipmi_smi_msg *msg;
407 ssif_info->req_events = false;
409 msg = ipmi_alloc_smi_msg();
411 ssif_info->ssif_state = SSIF_NORMAL;
415 ssif_info->curr_msg = msg;
416 ssif_info->ssif_state = SSIF_GETTING_EVENTS;
417 ipmi_ssif_unlock_cond(ssif_info, flags);
419 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
420 msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
423 check_start_send(ssif_info, flags, msg);
426 static void start_recv_msg_fetch(struct ssif_info *ssif_info,
427 unsigned long *flags)
429 struct ipmi_smi_msg *msg;
431 msg = ipmi_alloc_smi_msg();
433 ssif_info->ssif_state = SSIF_NORMAL;
437 ssif_info->curr_msg = msg;
438 ssif_info->ssif_state = SSIF_GETTING_MESSAGES;
439 ipmi_ssif_unlock_cond(ssif_info, flags);
441 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
442 msg->data[1] = IPMI_GET_MSG_CMD;
445 check_start_send(ssif_info, flags, msg);
449 * Must be called with the message lock held. This will release the
450 * message lock. Note that the caller will check SSIF_IDLE and start a
451 * new operation, so there is no need to check for new messages to
454 static void handle_flags(struct ssif_info *ssif_info, unsigned long *flags)
456 if (ssif_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
457 ipmi_smi_t intf = ssif_info->intf;
458 /* Watchdog pre-timeout */
459 ssif_inc_stat(ssif_info, watchdog_pretimeouts);
460 start_clear_flags(ssif_info, flags);
462 ipmi_smi_watchdog_pretimeout(intf);
463 } else if (ssif_info->msg_flags & RECEIVE_MSG_AVAIL)
464 /* Messages available. */
465 start_recv_msg_fetch(ssif_info, flags);
466 else if (ssif_info->msg_flags & EVENT_MSG_BUFFER_FULL)
467 /* Events available. */
468 start_event_fetch(ssif_info, flags);
470 ssif_info->ssif_state = SSIF_NORMAL;
471 ipmi_ssif_unlock_cond(ssif_info, flags);
475 static int ipmi_ssif_thread(void *data)
477 struct ssif_info *ssif_info = data;
479 while (!kthread_should_stop()) {
482 /* Wait for something to do */
483 result = wait_for_completion_interruptible(
484 &ssif_info->wake_thread);
485 if (ssif_info->stopping)
487 if (result == -ERESTARTSYS)
489 init_completion(&ssif_info->wake_thread);
491 if (ssif_info->i2c_read_write == I2C_SMBUS_WRITE) {
492 result = i2c_smbus_write_block_data(
493 ssif_info->client, ssif_info->i2c_command,
494 ssif_info->i2c_data[0],
495 ssif_info->i2c_data + 1);
496 ssif_info->done_handler(ssif_info, result, NULL, 0);
498 result = i2c_smbus_read_block_data(
499 ssif_info->client, ssif_info->i2c_command,
500 ssif_info->i2c_data);
502 ssif_info->done_handler(ssif_info, result,
505 ssif_info->done_handler(ssif_info, 0,
514 static int ssif_i2c_send(struct ssif_info *ssif_info,
515 ssif_i2c_done handler,
516 int read_write, int command,
517 unsigned char *data, unsigned int size)
519 ssif_info->done_handler = handler;
521 ssif_info->i2c_read_write = read_write;
522 ssif_info->i2c_command = command;
523 ssif_info->i2c_data = data;
524 ssif_info->i2c_size = size;
525 complete(&ssif_info->wake_thread);
530 static void msg_done_handler(struct ssif_info *ssif_info, int result,
531 unsigned char *data, unsigned int len);
533 static void start_get(struct ssif_info *ssif_info)
537 ssif_info->rtc_us_timer = 0;
538 ssif_info->multi_pos = 0;
540 rv = ssif_i2c_send(ssif_info, msg_done_handler, I2C_SMBUS_READ,
542 ssif_info->recv, I2C_SMBUS_BLOCK_DATA);
544 /* request failed, just return the error. */
545 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
546 pr_info("Error from i2c_non_blocking_op(5)\n");
548 msg_done_handler(ssif_info, -EIO, NULL, 0);
552 static void retry_timeout(unsigned long data)
554 struct ssif_info *ssif_info = (void *) data;
555 unsigned long oflags, *flags;
558 if (ssif_info->stopping)
561 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
562 waiting = ssif_info->waiting_alert;
563 ssif_info->waiting_alert = false;
564 ipmi_ssif_unlock_cond(ssif_info, flags);
567 start_get(ssif_info);
571 static void ssif_alert(struct i2c_client *client, enum i2c_alert_protocol type,
574 struct ssif_info *ssif_info = i2c_get_clientdata(client);
575 unsigned long oflags, *flags;
578 if (type != I2C_PROTOCOL_SMBUS_ALERT)
581 ssif_inc_stat(ssif_info, alerts);
583 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
584 if (ssif_info->waiting_alert) {
585 ssif_info->waiting_alert = false;
586 del_timer(&ssif_info->retry_timer);
588 } else if (ssif_info->curr_msg) {
589 ssif_info->got_alert = true;
591 ipmi_ssif_unlock_cond(ssif_info, flags);
593 start_get(ssif_info);
596 static int start_resend(struct ssif_info *ssif_info);
598 static void msg_done_handler(struct ssif_info *ssif_info, int result,
599 unsigned char *data, unsigned int len)
601 struct ipmi_smi_msg *msg;
602 unsigned long oflags, *flags;
606 * We are single-threaded here, so no need for a lock until we
607 * start messing with driver states or the queues.
611 ssif_info->retries_left--;
612 if (ssif_info->retries_left > 0) {
613 ssif_inc_stat(ssif_info, receive_retries);
615 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
616 ssif_info->waiting_alert = true;
617 ssif_info->rtc_us_timer = SSIF_MSG_USEC;
618 mod_timer(&ssif_info->retry_timer,
619 jiffies + SSIF_MSG_JIFFIES);
620 ipmi_ssif_unlock_cond(ssif_info, flags);
624 ssif_inc_stat(ssif_info, receive_errors);
626 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
627 pr_info("Error in msg_done_handler: %d\n", result);
632 if ((len > 1) && (ssif_info->multi_pos == 0)
633 && (data[0] == 0x00) && (data[1] == 0x01)) {
634 /* Start of multi-part read. Start the next transaction. */
637 ssif_inc_stat(ssif_info, received_message_parts);
639 /* Remove the multi-part read marker. */
641 for (i = 0; i < len; i++)
642 ssif_info->data[i] = data[i+2];
643 ssif_info->multi_len = len;
644 ssif_info->multi_pos = 1;
646 rv = ssif_i2c_send(ssif_info, msg_done_handler, I2C_SMBUS_READ,
647 SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE,
648 ssif_info->recv, I2C_SMBUS_BLOCK_DATA);
650 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
651 pr_info("Error from i2c_non_blocking_op(1)\n");
656 } else if (ssif_info->multi_pos) {
657 /* Middle of multi-part read. Start the next transaction. */
659 unsigned char blocknum;
663 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
664 pr_info(PFX "Middle message with no data\n");
671 if (ssif_info->multi_len + len - 1 > IPMI_MAX_MSG_LENGTH) {
672 /* Received message too big, abort the operation. */
674 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
675 pr_info("Received message too big\n");
680 /* Remove the blocknum from the data. */
682 for (i = 0; i < len; i++)
683 ssif_info->data[i + ssif_info->multi_len] = data[i + 1];
684 ssif_info->multi_len += len;
685 if (blocknum == 0xff) {
687 len = ssif_info->multi_len;
688 data = ssif_info->data;
689 } else if (blocknum + 1 != ssif_info->multi_pos) {
691 * Out of sequence block, just abort. Block
692 * numbers start at zero for the second block,
693 * but multi_pos starts at one, so the +1.
697 ssif_inc_stat(ssif_info, received_message_parts);
699 ssif_info->multi_pos++;
701 rv = ssif_i2c_send(ssif_info, msg_done_handler,
703 SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE,
705 I2C_SMBUS_BLOCK_DATA);
707 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
709 "Error from ssif_i2c_send\n");
718 ssif_inc_stat(ssif_info, receive_errors);
720 ssif_inc_stat(ssif_info, received_messages);
721 ssif_inc_stat(ssif_info, received_message_parts);
726 if (ssif_info->ssif_debug & SSIF_DEBUG_STATE)
727 pr_info(PFX "DONE 1: state = %d, result=%d.\n",
728 ssif_info->ssif_state, result);
730 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
731 msg = ssif_info->curr_msg;
734 if (msg->rsp_size > IPMI_MAX_MSG_LENGTH)
735 msg->rsp_size = IPMI_MAX_MSG_LENGTH;
736 memcpy(msg->rsp, data, msg->rsp_size);
737 ssif_info->curr_msg = NULL;
740 switch (ssif_info->ssif_state) {
742 ipmi_ssif_unlock_cond(ssif_info, flags);
747 return_hosed_msg(ssif_info, msg);
749 deliver_recv_msg(ssif_info, msg);
752 case SSIF_GETTING_FLAGS:
753 /* We got the flags from the SSIF, now handle them. */
754 if ((result < 0) || (len < 4) || (data[2] != 0)) {
756 * Error fetching flags, or invalid length,
757 * just give up for now.
759 ssif_info->ssif_state = SSIF_NORMAL;
760 ipmi_ssif_unlock_cond(ssif_info, flags);
761 pr_warn(PFX "Error getting flags: %d %d, %x\n",
762 result, len, data[2]);
763 } else if (data[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
764 || data[1] != IPMI_GET_MSG_FLAGS_CMD) {
765 pr_warn(PFX "Invalid response getting flags: %x %x\n",
768 ssif_inc_stat(ssif_info, flag_fetches);
769 ssif_info->msg_flags = data[3];
770 handle_flags(ssif_info, flags);
774 case SSIF_CLEARING_FLAGS:
775 /* We cleared the flags. */
776 if ((result < 0) || (len < 3) || (data[2] != 0)) {
777 /* Error clearing flags */
778 pr_warn(PFX "Error clearing flags: %d %d, %x\n",
779 result, len, data[2]);
780 } else if (data[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
781 || data[1] != IPMI_CLEAR_MSG_FLAGS_CMD) {
782 pr_warn(PFX "Invalid response clearing flags: %x %x\n",
785 ssif_info->ssif_state = SSIF_NORMAL;
786 ipmi_ssif_unlock_cond(ssif_info, flags);
789 case SSIF_GETTING_EVENTS:
790 if ((result < 0) || (len < 3) || (msg->rsp[2] != 0)) {
791 /* Error getting event, probably done. */
794 /* Take off the event flag. */
795 ssif_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
796 handle_flags(ssif_info, flags);
797 } else if (msg->rsp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
798 || msg->rsp[1] != IPMI_READ_EVENT_MSG_BUFFER_CMD) {
799 pr_warn(PFX "Invalid response getting events: %x %x\n",
800 msg->rsp[0], msg->rsp[1]);
802 /* Take off the event flag. */
803 ssif_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
804 handle_flags(ssif_info, flags);
806 handle_flags(ssif_info, flags);
807 ssif_inc_stat(ssif_info, events);
808 deliver_recv_msg(ssif_info, msg);
812 case SSIF_GETTING_MESSAGES:
813 if ((result < 0) || (len < 3) || (msg->rsp[2] != 0)) {
814 /* Error getting event, probably done. */
817 /* Take off the msg flag. */
818 ssif_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
819 handle_flags(ssif_info, flags);
820 } else if (msg->rsp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
821 || msg->rsp[1] != IPMI_GET_MSG_CMD) {
822 pr_warn(PFX "Invalid response clearing flags: %x %x\n",
823 msg->rsp[0], msg->rsp[1]);
826 /* Take off the msg flag. */
827 ssif_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
828 handle_flags(ssif_info, flags);
830 ssif_inc_stat(ssif_info, incoming_messages);
831 handle_flags(ssif_info, flags);
832 deliver_recv_msg(ssif_info, msg);
837 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
838 if (SSIF_IDLE(ssif_info) && !ssif_info->stopping) {
839 if (ssif_info->req_events)
840 start_event_fetch(ssif_info, flags);
841 else if (ssif_info->req_flags)
842 start_flag_fetch(ssif_info, flags);
844 start_next_msg(ssif_info, flags);
846 ipmi_ssif_unlock_cond(ssif_info, flags);
848 if (ssif_info->ssif_debug & SSIF_DEBUG_STATE)
849 pr_info(PFX "DONE 2: state = %d.\n", ssif_info->ssif_state);
852 static void msg_written_handler(struct ssif_info *ssif_info, int result,
853 unsigned char *data, unsigned int len)
857 /* We are single-threaded here, so no need for a lock. */
859 ssif_info->retries_left--;
860 if (ssif_info->retries_left > 0) {
861 if (!start_resend(ssif_info)) {
862 ssif_inc_stat(ssif_info, send_retries);
865 /* request failed, just return the error. */
866 ssif_inc_stat(ssif_info, send_errors);
868 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
870 "Out of retries in msg_written_handler\n");
871 msg_done_handler(ssif_info, -EIO, NULL, 0);
875 ssif_inc_stat(ssif_info, send_errors);
878 * Got an error on transmit, let the done routine
881 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
882 pr_info("Error in msg_written_handler: %d\n", result);
884 msg_done_handler(ssif_info, result, NULL, 0);
888 if (ssif_info->multi_data) {
890 * In the middle of a multi-data write. See the comment
891 * in the SSIF_MULTI_n_PART case in the probe function
892 * for details on the intricacies of this.
896 ssif_inc_stat(ssif_info, sent_messages_parts);
898 left = ssif_info->multi_len - ssif_info->multi_pos;
902 ssif_info->multi_data[ssif_info->multi_pos] = left;
903 ssif_info->multi_pos += left;
906 * Write is finished. Note that we must end
907 * with a write of less than 32 bytes to
908 * complete the transaction, even if it is
911 ssif_info->multi_data = NULL;
913 rv = ssif_i2c_send(ssif_info, msg_written_handler,
915 SSIF_IPMI_MULTI_PART_REQUEST_MIDDLE,
916 ssif_info->multi_data + ssif_info->multi_pos,
917 I2C_SMBUS_BLOCK_DATA);
919 /* request failed, just return the error. */
920 ssif_inc_stat(ssif_info, send_errors);
922 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
923 pr_info("Error from i2c_non_blocking_op(3)\n");
924 msg_done_handler(ssif_info, -EIO, NULL, 0);
927 /* Ready to request the result. */
928 unsigned long oflags, *flags;
930 ssif_inc_stat(ssif_info, sent_messages);
931 ssif_inc_stat(ssif_info, sent_messages_parts);
933 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
934 if (ssif_info->got_alert) {
935 /* The result is already ready, just start it. */
936 ssif_info->got_alert = false;
937 ipmi_ssif_unlock_cond(ssif_info, flags);
938 start_get(ssif_info);
940 /* Wait a jiffie then request the next message */
941 ssif_info->waiting_alert = true;
942 ssif_info->retries_left = SSIF_RECV_RETRIES;
943 ssif_info->rtc_us_timer = SSIF_MSG_PART_USEC;
944 mod_timer(&ssif_info->retry_timer,
945 jiffies + SSIF_MSG_PART_JIFFIES);
946 ipmi_ssif_unlock_cond(ssif_info, flags);
951 static int start_resend(struct ssif_info *ssif_info)
956 ssif_info->got_alert = false;
958 if (ssif_info->data_len > 32) {
959 command = SSIF_IPMI_MULTI_PART_REQUEST_START;
960 ssif_info->multi_data = ssif_info->data;
961 ssif_info->multi_len = ssif_info->data_len;
963 * Subtle thing, this is 32, not 33, because we will
964 * overwrite the thing at position 32 (which was just
965 * transmitted) with the new length.
967 ssif_info->multi_pos = 32;
968 ssif_info->data[0] = 32;
970 ssif_info->multi_data = NULL;
971 command = SSIF_IPMI_REQUEST;
972 ssif_info->data[0] = ssif_info->data_len;
975 rv = ssif_i2c_send(ssif_info, msg_written_handler, I2C_SMBUS_WRITE,
976 command, ssif_info->data, I2C_SMBUS_BLOCK_DATA);
977 if (rv && (ssif_info->ssif_debug & SSIF_DEBUG_MSG))
978 pr_info("Error from i2c_non_blocking_op(4)\n");
982 static int start_send(struct ssif_info *ssif_info,
986 if (len > IPMI_MAX_MSG_LENGTH)
988 if (len > ssif_info->max_xmit_msg_size)
991 ssif_info->retries_left = SSIF_SEND_RETRIES;
992 memcpy(ssif_info->data + 1, data, len);
993 ssif_info->data_len = len;
994 return start_resend(ssif_info);
997 /* Must be called with the message lock held. */
998 static void start_next_msg(struct ssif_info *ssif_info, unsigned long *flags)
1000 struct ipmi_smi_msg *msg;
1001 unsigned long oflags;
1004 if (!SSIF_IDLE(ssif_info)) {
1005 ipmi_ssif_unlock_cond(ssif_info, flags);
1009 if (!ssif_info->waiting_msg) {
1010 ssif_info->curr_msg = NULL;
1011 ipmi_ssif_unlock_cond(ssif_info, flags);
1015 ssif_info->curr_msg = ssif_info->waiting_msg;
1016 ssif_info->waiting_msg = NULL;
1017 ipmi_ssif_unlock_cond(ssif_info, flags);
1018 rv = start_send(ssif_info,
1019 ssif_info->curr_msg->data,
1020 ssif_info->curr_msg->data_size);
1022 msg = ssif_info->curr_msg;
1023 ssif_info->curr_msg = NULL;
1024 return_hosed_msg(ssif_info, msg);
1025 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1031 static void sender(void *send_info,
1032 struct ipmi_smi_msg *msg)
1034 struct ssif_info *ssif_info = (struct ssif_info *) send_info;
1035 unsigned long oflags, *flags;
1037 BUG_ON(ssif_info->waiting_msg);
1038 ssif_info->waiting_msg = msg;
1040 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1041 start_next_msg(ssif_info, flags);
1043 if (ssif_info->ssif_debug & SSIF_DEBUG_TIMING) {
1044 struct timespec64 t;
1046 ktime_get_real_ts64(&t);
1047 pr_info("**Enqueue %02x %02x: %lld.%6.6ld\n",
1048 msg->data[0], msg->data[1],
1049 (long long) t.tv_sec, (long) t.tv_nsec / NSEC_PER_USEC);
1053 static int get_smi_info(void *send_info, struct ipmi_smi_info *data)
1055 struct ssif_info *ssif_info = send_info;
1057 data->addr_src = ssif_info->addr_source;
1058 data->dev = &ssif_info->client->dev;
1059 data->addr_info = ssif_info->addr_info;
1060 get_device(data->dev);
1066 * Instead of having our own timer to periodically check the message
1067 * flags, we let the message handler drive us.
1069 static void request_events(void *send_info)
1071 struct ssif_info *ssif_info = (struct ssif_info *) send_info;
1072 unsigned long oflags, *flags;
1074 if (!ssif_info->has_event_buffer)
1077 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1079 * Request flags first, not events, because the lower layer
1080 * doesn't have a way to send an attention. But make sure
1081 * event checking still happens.
1083 ssif_info->req_events = true;
1084 if (SSIF_IDLE(ssif_info))
1085 start_flag_fetch(ssif_info, flags);
1087 ssif_info->req_flags = true;
1088 ipmi_ssif_unlock_cond(ssif_info, flags);
1092 static int inc_usecount(void *send_info)
1094 struct ssif_info *ssif_info = send_info;
1096 if (!i2c_get_adapter(ssif_info->client->adapter->nr))
1099 i2c_use_client(ssif_info->client);
1103 static void dec_usecount(void *send_info)
1105 struct ssif_info *ssif_info = send_info;
1107 i2c_release_client(ssif_info->client);
1108 i2c_put_adapter(ssif_info->client->adapter);
1111 static int ssif_start_processing(void *send_info,
1114 struct ssif_info *ssif_info = send_info;
1116 ssif_info->intf = intf;
1121 #define MAX_SSIF_BMCS 4
1123 static unsigned short addr[MAX_SSIF_BMCS];
1124 static int num_addrs;
1125 module_param_array(addr, ushort, &num_addrs, 0);
1126 MODULE_PARM_DESC(addr, "The addresses to scan for IPMI BMCs on the SSIFs.");
1128 static char *adapter_name[MAX_SSIF_BMCS];
1129 static int num_adapter_names;
1130 module_param_array(adapter_name, charp, &num_adapter_names, 0);
1131 MODULE_PARM_DESC(adapter_name, "The string name of the I2C device that has the BMC. By default all devices are scanned.");
1133 static int slave_addrs[MAX_SSIF_BMCS];
1134 static int num_slave_addrs;
1135 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1136 MODULE_PARM_DESC(slave_addrs,
1137 "The default IPMB slave address for the controller.");
1139 static bool alerts_broken;
1140 module_param(alerts_broken, bool, 0);
1141 MODULE_PARM_DESC(alerts_broken, "Don't enable alerts for the controller.");
1144 * Bit 0 enables message debugging, bit 1 enables state debugging, and
1145 * bit 2 enables timing debugging. This is an array indexed by
1148 static int dbg[MAX_SSIF_BMCS];
1150 module_param_array(dbg, int, &num_dbg, 0);
1151 MODULE_PARM_DESC(dbg, "Turn on debugging.");
1153 static bool ssif_dbg_probe;
1154 module_param_named(dbg_probe, ssif_dbg_probe, bool, 0);
1155 MODULE_PARM_DESC(dbg_probe, "Enable debugging of probing of adapters.");
1157 static int use_thread;
1158 module_param(use_thread, int, 0);
1159 MODULE_PARM_DESC(use_thread, "Use the thread interface.");
1161 static bool ssif_tryacpi = true;
1162 module_param_named(tryacpi, ssif_tryacpi, bool, 0);
1163 MODULE_PARM_DESC(tryacpi, "Setting this to zero will disable the default scan of the interfaces identified via ACPI");
1165 static bool ssif_trydmi = true;
1166 module_param_named(trydmi, ssif_trydmi, bool, 0);
1167 MODULE_PARM_DESC(trydmi, "Setting this to zero will disable the default scan of the interfaces identified via DMI (SMBIOS)");
1169 static DEFINE_MUTEX(ssif_infos_mutex);
1170 static LIST_HEAD(ssif_infos);
1172 static int ssif_remove(struct i2c_client *client)
1174 struct ssif_info *ssif_info = i2c_get_clientdata(client);
1181 * After this point, we won't deliver anything asychronously
1182 * to the message handler. We can unregister ourself.
1184 rv = ipmi_unregister_smi(ssif_info->intf);
1186 pr_err(PFX "Unable to unregister device: errno=%d\n", rv);
1189 ssif_info->intf = NULL;
1191 /* make sure the driver is not looking for flags any more. */
1192 while (ssif_info->ssif_state != SSIF_NORMAL)
1193 schedule_timeout(1);
1195 ssif_info->stopping = true;
1196 del_timer_sync(&ssif_info->retry_timer);
1197 if (ssif_info->thread) {
1198 complete(&ssif_info->wake_thread);
1199 kthread_stop(ssif_info->thread);
1203 * No message can be outstanding now, we have removed the
1204 * upper layer and it permitted us to do so.
1210 static int do_cmd(struct i2c_client *client, int len, unsigned char *msg,
1211 int *resp_len, unsigned char *resp)
1216 retry_cnt = SSIF_SEND_RETRIES;
1218 ret = i2c_smbus_write_block_data(client, SSIF_IPMI_REQUEST, len, msg);
1227 retry_cnt = SSIF_RECV_RETRIES;
1228 while (retry_cnt > 0) {
1229 ret = i2c_smbus_read_block_data(client, SSIF_IPMI_RESPONSE,
1233 msleep(SSIF_MSG_MSEC);
1240 /* Validate that the response is correct. */
1242 (resp[0] != (msg[0] | (1 << 2))) ||
1243 (resp[1] != msg[1]))
1254 static int ssif_detect(struct i2c_client *client, struct i2c_board_info *info)
1256 unsigned char *resp;
1257 unsigned char msg[3];
1261 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1265 /* Do a Get Device ID command, since it is required. */
1266 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1267 msg[1] = IPMI_GET_DEVICE_ID_CMD;
1268 rv = do_cmd(client, 2, msg, &len, resp);
1272 strlcpy(info->type, DEVICE_NAME, I2C_NAME_SIZE);
1277 static int smi_type_proc_show(struct seq_file *m, void *v)
1279 seq_puts(m, "ssif\n");
1284 static int smi_type_proc_open(struct inode *inode, struct file *file)
1286 return single_open(file, smi_type_proc_show, inode->i_private);
1289 static const struct file_operations smi_type_proc_ops = {
1290 .open = smi_type_proc_open,
1292 .llseek = seq_lseek,
1293 .release = single_release,
1296 static int smi_stats_proc_show(struct seq_file *m, void *v)
1298 struct ssif_info *ssif_info = m->private;
1300 seq_printf(m, "sent_messages: %u\n",
1301 ssif_get_stat(ssif_info, sent_messages));
1302 seq_printf(m, "sent_messages_parts: %u\n",
1303 ssif_get_stat(ssif_info, sent_messages_parts));
1304 seq_printf(m, "send_retries: %u\n",
1305 ssif_get_stat(ssif_info, send_retries));
1306 seq_printf(m, "send_errors: %u\n",
1307 ssif_get_stat(ssif_info, send_errors));
1308 seq_printf(m, "received_messages: %u\n",
1309 ssif_get_stat(ssif_info, received_messages));
1310 seq_printf(m, "received_message_parts: %u\n",
1311 ssif_get_stat(ssif_info, received_message_parts));
1312 seq_printf(m, "receive_retries: %u\n",
1313 ssif_get_stat(ssif_info, receive_retries));
1314 seq_printf(m, "receive_errors: %u\n",
1315 ssif_get_stat(ssif_info, receive_errors));
1316 seq_printf(m, "flag_fetches: %u\n",
1317 ssif_get_stat(ssif_info, flag_fetches));
1318 seq_printf(m, "hosed: %u\n",
1319 ssif_get_stat(ssif_info, hosed));
1320 seq_printf(m, "events: %u\n",
1321 ssif_get_stat(ssif_info, events));
1322 seq_printf(m, "watchdog_pretimeouts: %u\n",
1323 ssif_get_stat(ssif_info, watchdog_pretimeouts));
1324 seq_printf(m, "alerts: %u\n",
1325 ssif_get_stat(ssif_info, alerts));
1329 static int smi_stats_proc_open(struct inode *inode, struct file *file)
1331 return single_open(file, smi_stats_proc_show, PDE_DATA(inode));
1334 static const struct file_operations smi_stats_proc_ops = {
1335 .open = smi_stats_proc_open,
1337 .llseek = seq_lseek,
1338 .release = single_release,
1341 static int strcmp_nospace(char *s1, char *s2)
1343 while (*s1 && *s2) {
1344 while (isspace(*s1))
1346 while (isspace(*s2))
1358 static struct ssif_addr_info *ssif_info_find(unsigned short addr,
1360 bool match_null_name)
1362 struct ssif_addr_info *info, *found = NULL;
1365 list_for_each_entry(info, &ssif_infos, link) {
1366 if (info->binfo.addr == addr) {
1367 if (info->adapter_name || adapter_name) {
1368 if (!info->adapter_name != !adapter_name) {
1369 /* One is NULL and one is not */
1373 strcmp_nospace(info->adapter_name,
1375 /* Names do not match */
1383 if (!found && match_null_name) {
1384 /* Try to get an exact match first, then try with a NULL name */
1385 adapter_name = NULL;
1386 match_null_name = false;
1393 static bool check_acpi(struct ssif_info *ssif_info, struct device *dev)
1396 acpi_handle acpi_handle;
1398 acpi_handle = ACPI_HANDLE(dev);
1400 ssif_info->addr_source = SI_ACPI;
1401 ssif_info->addr_info.acpi_info.acpi_handle = acpi_handle;
1409 * Global enables we care about.
1411 #define GLOBAL_ENABLES_MASK (IPMI_BMC_EVT_MSG_BUFF | IPMI_BMC_RCV_MSG_INTR | \
1412 IPMI_BMC_EVT_MSG_INTR)
1414 static int ssif_probe(struct i2c_client *client, const struct i2c_device_id *id)
1416 unsigned char msg[3];
1417 unsigned char *resp;
1418 struct ssif_info *ssif_info;
1423 struct ssif_addr_info *addr_info = NULL;
1426 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1430 ssif_info = kzalloc(sizeof(*ssif_info), GFP_KERNEL);
1436 if (!check_acpi(ssif_info, &client->dev)) {
1437 addr_info = ssif_info_find(client->addr, client->adapter->name,
1440 /* Must have come in through sysfs. */
1441 ssif_info->addr_source = SI_HOTMOD;
1443 ssif_info->addr_source = addr_info->addr_src;
1444 ssif_info->ssif_debug = addr_info->debug;
1445 ssif_info->addr_info = addr_info->addr_info;
1446 slave_addr = addr_info->slave_addr;
1450 pr_info(PFX "Trying %s-specified SSIF interface at i2c address 0x%x, adapter %s, slave address 0x%x\n",
1451 ipmi_addr_src_to_str(ssif_info->addr_source),
1452 client->addr, client->adapter->name, slave_addr);
1455 * Do a Get Device ID command, since it comes back with some
1458 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1459 msg[1] = IPMI_GET_DEVICE_ID_CMD;
1460 rv = do_cmd(client, 2, msg, &len, resp);
1464 rv = ipmi_demangle_device_id(resp, len, &ssif_info->device_id);
1468 ssif_info->client = client;
1469 i2c_set_clientdata(client, ssif_info);
1471 /* Now check for system interface capabilities */
1472 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1473 msg[1] = IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_CMD;
1474 msg[2] = 0; /* SSIF */
1475 rv = do_cmd(client, 3, msg, &len, resp);
1476 if (!rv && (len >= 3) && (resp[2] == 0)) {
1479 pr_info(PFX "SSIF info too short: %d\n", len);
1483 /* Got a good SSIF response, handle it. */
1484 ssif_info->max_xmit_msg_size = resp[5];
1485 ssif_info->max_recv_msg_size = resp[6];
1486 ssif_info->multi_support = (resp[4] >> 6) & 0x3;
1487 ssif_info->supports_pec = (resp[4] >> 3) & 0x1;
1489 /* Sanitize the data */
1490 switch (ssif_info->multi_support) {
1492 if (ssif_info->max_xmit_msg_size > 32)
1493 ssif_info->max_xmit_msg_size = 32;
1494 if (ssif_info->max_recv_msg_size > 32)
1495 ssif_info->max_recv_msg_size = 32;
1498 case SSIF_MULTI_2_PART:
1499 if (ssif_info->max_xmit_msg_size > 63)
1500 ssif_info->max_xmit_msg_size = 63;
1501 if (ssif_info->max_recv_msg_size > 62)
1502 ssif_info->max_recv_msg_size = 62;
1505 case SSIF_MULTI_n_PART:
1507 * The specification is rather confusing at
1508 * this point, but I think I understand what
1509 * is meant. At least I have a workable
1510 * solution. With multi-part messages, you
1511 * cannot send a message that is a multiple of
1512 * 32-bytes in length, because the start and
1513 * middle messages are 32-bytes and the end
1514 * message must be at least one byte. You
1515 * can't fudge on an extra byte, that would
1516 * screw up things like fru data writes. So
1517 * we limit the length to 63 bytes. That way
1518 * a 32-byte message gets sent as a single
1519 * part. A larger message will be a 32-byte
1520 * start and the next message is always going
1521 * to be 1-31 bytes in length. Not ideal, but
1524 if (ssif_info->max_xmit_msg_size > 63)
1525 ssif_info->max_xmit_msg_size = 63;
1529 /* Data is not sane, just give up. */
1534 /* Assume no multi-part or PEC support */
1535 pr_info(PFX "Error fetching SSIF: %d %d %2.2x, your system probably doesn't support this command so using defaults\n",
1538 ssif_info->max_xmit_msg_size = 32;
1539 ssif_info->max_recv_msg_size = 32;
1540 ssif_info->multi_support = SSIF_NO_MULTI;
1541 ssif_info->supports_pec = 0;
1544 /* Make sure the NMI timeout is cleared. */
1545 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1546 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
1547 msg[2] = WDT_PRE_TIMEOUT_INT;
1548 rv = do_cmd(client, 3, msg, &len, resp);
1549 if (rv || (len < 3) || (resp[2] != 0))
1550 pr_warn(PFX "Unable to clear message flags: %d %d %2.2x\n",
1553 /* Attempt to enable the event buffer. */
1554 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1555 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
1556 rv = do_cmd(client, 2, msg, &len, resp);
1557 if (rv || (len < 4) || (resp[2] != 0)) {
1558 pr_warn(PFX "Error getting global enables: %d %d %2.2x\n",
1560 rv = 0; /* Not fatal */
1564 ssif_info->global_enables = resp[3];
1566 if (resp[3] & IPMI_BMC_EVT_MSG_BUFF) {
1567 ssif_info->has_event_buffer = true;
1568 /* buffer is already enabled, nothing to do. */
1572 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1573 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
1574 msg[2] = ssif_info->global_enables | IPMI_BMC_EVT_MSG_BUFF;
1575 rv = do_cmd(client, 3, msg, &len, resp);
1576 if (rv || (len < 2)) {
1577 pr_warn(PFX "Error setting global enables: %d %d %2.2x\n",
1579 rv = 0; /* Not fatal */
1584 /* A successful return means the event buffer is supported. */
1585 ssif_info->has_event_buffer = true;
1586 ssif_info->global_enables |= IPMI_BMC_EVT_MSG_BUFF;
1589 /* Some systems don't behave well if you enable alerts. */
1593 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1594 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
1595 msg[2] = ssif_info->global_enables | IPMI_BMC_RCV_MSG_INTR;
1596 rv = do_cmd(client, 3, msg, &len, resp);
1597 if (rv || (len < 2)) {
1598 pr_warn(PFX "Error setting global enables: %d %d %2.2x\n",
1600 rv = 0; /* Not fatal */
1605 /* A successful return means the alert is supported. */
1606 ssif_info->supports_alert = true;
1607 ssif_info->global_enables |= IPMI_BMC_RCV_MSG_INTR;
1611 ssif_info->intf_num = atomic_inc_return(&next_intf);
1613 if (ssif_dbg_probe) {
1614 pr_info("ssif_probe: i2c_probe found device at i2c address %x\n",
1618 spin_lock_init(&ssif_info->lock);
1619 ssif_info->ssif_state = SSIF_NORMAL;
1620 init_timer(&ssif_info->retry_timer);
1621 ssif_info->retry_timer.data = (unsigned long) ssif_info;
1622 ssif_info->retry_timer.function = retry_timeout;
1624 for (i = 0; i < SSIF_NUM_STATS; i++)
1625 atomic_set(&ssif_info->stats[i], 0);
1627 if (ssif_info->supports_pec)
1628 ssif_info->client->flags |= I2C_CLIENT_PEC;
1630 ssif_info->handlers.owner = THIS_MODULE;
1631 ssif_info->handlers.start_processing = ssif_start_processing;
1632 ssif_info->handlers.get_smi_info = get_smi_info;
1633 ssif_info->handlers.sender = sender;
1634 ssif_info->handlers.request_events = request_events;
1635 ssif_info->handlers.inc_usecount = inc_usecount;
1636 ssif_info->handlers.dec_usecount = dec_usecount;
1639 unsigned int thread_num;
1641 thread_num = ((ssif_info->client->adapter->nr << 8) |
1642 ssif_info->client->addr);
1643 init_completion(&ssif_info->wake_thread);
1644 ssif_info->thread = kthread_run(ipmi_ssif_thread, ssif_info,
1645 "kssif%4.4x", thread_num);
1646 if (IS_ERR(ssif_info->thread)) {
1647 rv = PTR_ERR(ssif_info->thread);
1648 dev_notice(&ssif_info->client->dev,
1649 "Could not start kernel thread: error %d\n",
1655 rv = ipmi_register_smi(&ssif_info->handlers,
1657 &ssif_info->device_id,
1658 &ssif_info->client->dev,
1661 pr_err(PFX "Unable to register device: error %d\n", rv);
1665 rv = ipmi_smi_add_proc_entry(ssif_info->intf, "type",
1669 pr_err(PFX "Unable to create proc entry: %d\n", rv);
1673 rv = ipmi_smi_add_proc_entry(ssif_info->intf, "ssif_stats",
1674 &smi_stats_proc_ops,
1677 pr_err(PFX "Unable to create proc entry: %d\n", rv);
1688 ipmi_unregister_smi(ssif_info->intf);
1692 static int ssif_adapter_handler(struct device *adev, void *opaque)
1694 struct ssif_addr_info *addr_info = opaque;
1696 if (adev->type != &i2c_adapter_type)
1699 i2c_new_device(to_i2c_adapter(adev), &addr_info->binfo);
1701 if (!addr_info->adapter_name)
1702 return 1; /* Only try the first I2C adapter by default. */
1706 static int new_ssif_client(int addr, char *adapter_name,
1707 int debug, int slave_addr,
1708 enum ipmi_addr_src addr_src)
1710 struct ssif_addr_info *addr_info;
1713 mutex_lock(&ssif_infos_mutex);
1714 if (ssif_info_find(addr, adapter_name, false)) {
1719 addr_info = kzalloc(sizeof(*addr_info), GFP_KERNEL);
1726 addr_info->adapter_name = kstrdup(adapter_name, GFP_KERNEL);
1727 if (!addr_info->adapter_name) {
1734 strncpy(addr_info->binfo.type, DEVICE_NAME,
1735 sizeof(addr_info->binfo.type));
1736 addr_info->binfo.addr = addr;
1737 addr_info->binfo.platform_data = addr_info;
1738 addr_info->debug = debug;
1739 addr_info->slave_addr = slave_addr;
1740 addr_info->addr_src = addr_src;
1742 list_add_tail(&addr_info->link, &ssif_infos);
1745 i2c_for_each_dev(addr_info, ssif_adapter_handler);
1746 /* Otherwise address list will get it */
1749 mutex_unlock(&ssif_infos_mutex);
1753 static void free_ssif_clients(void)
1755 struct ssif_addr_info *info, *tmp;
1757 mutex_lock(&ssif_infos_mutex);
1758 list_for_each_entry_safe(info, tmp, &ssif_infos, link) {
1759 list_del(&info->link);
1760 kfree(info->adapter_name);
1763 mutex_unlock(&ssif_infos_mutex);
1766 static unsigned short *ssif_address_list(void)
1768 struct ssif_addr_info *info;
1769 unsigned int count = 0, i;
1770 unsigned short *address_list;
1772 list_for_each_entry(info, &ssif_infos, link)
1775 address_list = kzalloc(sizeof(*address_list) * (count + 1), GFP_KERNEL);
1780 list_for_each_entry(info, &ssif_infos, link) {
1781 unsigned short addr = info->binfo.addr;
1784 for (j = 0; j < i; j++) {
1785 if (address_list[j] == addr)
1788 address_list[i] = addr;
1792 address_list[i] = I2C_CLIENT_END;
1794 return address_list;
1798 static const struct acpi_device_id ssif_acpi_match[] = {
1802 MODULE_DEVICE_TABLE(acpi, ssif_acpi_match);
1805 * Once we get an ACPI failure, we don't try any more, because we go
1806 * through the tables sequentially. Once we don't find a table, there
1809 static int acpi_failure;
1812 * Defined in the IPMI 2.0 spec.
1823 s8 CreatorRevision[4];
1826 s16 SpecificationRevision;
1829 * Bit 0 - SCI interrupt supported
1830 * Bit 1 - I/O APIC/SAPIC
1835 * If bit 0 of InterruptType is set, then this is the SCI
1836 * interrupt in the GPEx_STS register.
1843 * If bit 1 of InterruptType is set, then this is the I/O
1844 * APIC/SAPIC interrupt.
1846 u32 GlobalSystemInterrupt;
1848 /* The actual register address. */
1849 struct acpi_generic_address addr;
1853 s8 spmi_id[1]; /* A '\0' terminated array starts here. */
1856 static int try_init_spmi(struct SPMITable *spmi)
1858 unsigned short myaddr;
1860 if (num_addrs >= MAX_SSIF_BMCS)
1863 if (spmi->IPMIlegacy != 1) {
1864 pr_warn("IPMI: Bad SPMI legacy: %d\n", spmi->IPMIlegacy);
1868 if (spmi->InterfaceType != 4)
1871 if (spmi->addr.space_id != ACPI_ADR_SPACE_SMBUS) {
1872 pr_warn(PFX "Invalid ACPI SSIF I/O Address type: %d\n",
1873 spmi->addr.space_id);
1877 myaddr = spmi->addr.address & 0x7f;
1879 return new_ssif_client(myaddr, NULL, 0, 0, SI_SPMI);
1882 static void spmi_find_bmc(void)
1885 struct SPMITable *spmi;
1894 for (i = 0; ; i++) {
1895 status = acpi_get_table(ACPI_SIG_SPMI, i+1,
1896 (struct acpi_table_header **)&spmi);
1897 if (status != AE_OK)
1900 try_init_spmi(spmi);
1904 static void spmi_find_bmc(void) { }
1908 static int decode_dmi(const struct dmi_device *dmi_dev)
1910 struct dmi_header *dm = dmi_dev->device_data;
1911 u8 *data = (u8 *) dm;
1912 u8 len = dm->length;
1913 unsigned short myaddr;
1916 if (num_addrs >= MAX_SSIF_BMCS)
1922 if (data[0x04] != 4) /* Not SSIF */
1925 if ((data[8] >> 1) == 0) {
1927 * Some broken systems put the I2C address in
1928 * the slave address field. We try to
1929 * accommodate them here.
1931 myaddr = data[6] >> 1;
1934 myaddr = data[8] >> 1;
1935 slave_addr = data[6];
1938 return new_ssif_client(myaddr, NULL, 0, 0, SI_SMBIOS);
1941 static void dmi_iterator(void)
1943 const struct dmi_device *dev = NULL;
1945 while ((dev = dmi_find_device(DMI_DEV_TYPE_IPMI, NULL, dev)))
1949 static void dmi_iterator(void) { }
1952 static const struct i2c_device_id ssif_id[] = {
1956 MODULE_DEVICE_TABLE(i2c, ssif_id);
1958 static struct i2c_driver ssif_i2c_driver = {
1959 .class = I2C_CLASS_HWMON,
1963 .probe = ssif_probe,
1964 .remove = ssif_remove,
1965 .alert = ssif_alert,
1966 .id_table = ssif_id,
1967 .detect = ssif_detect
1970 static int init_ipmi_ssif(void)
1978 pr_info("IPMI SSIF Interface driver\n");
1980 /* build list for i2c from addr list */
1981 for (i = 0; i < num_addrs; i++) {
1982 rv = new_ssif_client(addr[i], adapter_name[i],
1983 dbg[i], slave_addrs[i],
1987 "Couldn't add hardcoded device at addr 0x%x\n",
1992 ssif_i2c_driver.driver.acpi_match_table =
1993 ACPI_PTR(ssif_acpi_match);
1999 ssif_i2c_driver.address_list = ssif_address_list();
2001 rv = i2c_add_driver(&ssif_i2c_driver);
2007 module_init(init_ipmi_ssif);
2009 static void cleanup_ipmi_ssif(void)
2014 initialized = false;
2016 i2c_del_driver(&ssif_i2c_driver);
2018 free_ssif_clients();
2020 module_exit(cleanup_ipmi_ssif);
2022 MODULE_AUTHOR("Todd C Davis <todd.c.davis@intel.com>, Corey Minyard <minyard@acm.org>");
2023 MODULE_DESCRIPTION("IPMI driver for management controllers on a SMBus");
2024 MODULE_LICENSE("GPL");