1 // SPDX-License-Identifier: GPL-2.0+
5 * The interface to the IPMI driver for SMBus access to a SMBus
6 * compliant device. Called SSIF by the IPMI spec.
8 * Author: Intel Corporation
9 * Todd Davis <todd.c.davis@intel.com>
11 * Rewritten by Corey Minyard <minyard@acm.org> to support the
12 * non-blocking I2C interface, add support for multi-part
13 * transactions, add PEC support, and general clenaup.
15 * Copyright 2003 Intel Corporation
16 * Copyright 2005 MontaVista Software
20 * This file holds the "policy" for the interface to the SSIF state
21 * machine. It does the configuration, handles timers and interrupts,
22 * and drives the real SSIF state machine.
26 * TODO: Figure out how to use SMB alerts. This will require a new
27 * interface into the I2C driver, I believe.
30 #if defined(MODVERSIONS)
31 #include <linux/modversions.h>
34 #include <linux/module.h>
35 #include <linux/moduleparam.h>
36 #include <linux/sched.h>
37 #include <linux/seq_file.h>
38 #include <linux/timer.h>
39 #include <linux/delay.h>
40 #include <linux/errno.h>
41 #include <linux/spinlock.h>
42 #include <linux/slab.h>
43 #include <linux/list.h>
44 #include <linux/i2c.h>
45 #include <linux/ipmi_smi.h>
46 #include <linux/init.h>
47 #include <linux/dmi.h>
48 #include <linux/kthread.h>
49 #include <linux/acpi.h>
50 #include <linux/ctype.h>
51 #include <linux/time64.h>
52 #include "ipmi_si_sm.h"
55 #define PFX "ipmi_ssif: "
56 #define DEVICE_NAME "ipmi_ssif"
58 #define IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_CMD 0x57
60 #define SSIF_IPMI_REQUEST 2
61 #define SSIF_IPMI_MULTI_PART_REQUEST_START 6
62 #define SSIF_IPMI_MULTI_PART_REQUEST_MIDDLE 7
63 #define SSIF_IPMI_RESPONSE 3
64 #define SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE 9
66 /* ssif_debug is a bit-field
67 * SSIF_DEBUG_MSG - commands and their responses
68 * SSIF_DEBUG_STATES - message states
69 * SSIF_DEBUG_TIMING - Measure times between events in the driver
71 #define SSIF_DEBUG_TIMING 4
72 #define SSIF_DEBUG_STATE 2
73 #define SSIF_DEBUG_MSG 1
74 #define SSIF_NODEBUG 0
75 #define SSIF_DEFAULT_DEBUG (SSIF_NODEBUG)
80 #define SSIF_MSG_USEC 20000 /* 20ms between message tries. */
81 #define SSIF_MSG_PART_USEC 5000 /* 5ms for a message part */
83 /* How many times to we retry sending/receiving the message. */
84 #define SSIF_SEND_RETRIES 5
85 #define SSIF_RECV_RETRIES 250
87 #define SSIF_MSG_MSEC (SSIF_MSG_USEC / 1000)
88 #define SSIF_MSG_JIFFIES ((SSIF_MSG_USEC * 1000) / TICK_NSEC)
89 #define SSIF_MSG_PART_JIFFIES ((SSIF_MSG_PART_USEC * 1000) / TICK_NSEC)
91 enum ssif_intf_state {
96 SSIF_GETTING_MESSAGES,
97 /* FIXME - add watchdog stuff. */
100 #define SSIF_IDLE(ssif) ((ssif)->ssif_state == SSIF_NORMAL \
101 && (ssif)->curr_msg == NULL)
104 * Indexes into stats[] in ssif_info below.
106 enum ssif_stat_indexes {
107 /* Number of total messages sent. */
108 SSIF_STAT_sent_messages = 0,
111 * Number of message parts sent. Messages may be broken into
112 * parts if they are long.
114 SSIF_STAT_sent_messages_parts,
117 * Number of time a message was retried.
119 SSIF_STAT_send_retries,
122 * Number of times the send of a message failed.
124 SSIF_STAT_send_errors,
127 * Number of message responses received.
129 SSIF_STAT_received_messages,
132 * Number of message fragments received.
134 SSIF_STAT_received_message_parts,
137 * Number of times the receive of a message was retried.
139 SSIF_STAT_receive_retries,
142 * Number of errors receiving messages.
144 SSIF_STAT_receive_errors,
147 * Number of times a flag fetch was requested.
149 SSIF_STAT_flag_fetches,
152 * Number of times the hardware didn't follow the state machine.
157 * Number of received events.
161 /* Number of asyncronous messages received. */
162 SSIF_STAT_incoming_messages,
164 /* Number of watchdog pretimeouts. */
165 SSIF_STAT_watchdog_pretimeouts,
167 /* Number of alers received. */
170 /* Always add statistics before this value, it must be last. */
174 struct ssif_addr_info {
175 struct i2c_board_info binfo;
179 enum ipmi_addr_src addr_src;
180 union ipmi_smi_info_union addr_info;
182 struct i2c_client *client;
184 struct mutex clients_mutex;
185 struct list_head clients;
187 struct list_head link;
192 typedef void (*ssif_i2c_done)(struct ssif_info *ssif_info, int result,
193 unsigned char *data, unsigned int len);
196 struct ipmi_smi *intf;
198 struct ipmi_smi_msg *waiting_msg;
199 struct ipmi_smi_msg *curr_msg;
200 enum ssif_intf_state ssif_state;
201 unsigned long ssif_debug;
203 struct ipmi_smi_handlers handlers;
205 enum ipmi_addr_src addr_source; /* ACPI, PCI, SMBIOS, hardcode, etc. */
206 union ipmi_smi_info_union addr_info;
209 * Flags from the last GET_MSG_FLAGS command, used when an ATTN
210 * is set to hold the flags until we are done handling everything
213 #define RECEIVE_MSG_AVAIL 0x01
214 #define EVENT_MSG_BUFFER_FULL 0x02
215 #define WDT_PRE_TIMEOUT_INT 0x08
216 unsigned char msg_flags;
219 bool has_event_buffer;
223 * Used to tell what we should do with alerts. If we are
224 * waiting on a response, read the data immediately.
230 * If set to true, this will request events the next time the
231 * state machine is idle.
236 * If set to true, this will request flags the next time the
237 * state machine is idle.
242 * Used to perform timer operations when run-to-completion
243 * mode is on. This is a countdown timer.
247 /* Used for sending/receiving data. +1 for the length. */
248 unsigned char data[IPMI_MAX_MSG_LENGTH + 1];
249 unsigned int data_len;
251 /* Temp receive buffer, gets copied into data. */
252 unsigned char recv[I2C_SMBUS_BLOCK_MAX];
254 struct i2c_client *client;
255 ssif_i2c_done done_handler;
257 /* Thread interface handling */
258 struct task_struct *thread;
259 struct completion wake_thread;
263 unsigned char *i2c_data;
264 unsigned int i2c_size;
266 struct timer_list retry_timer;
269 /* Info from SSIF cmd */
270 unsigned char max_xmit_msg_size;
271 unsigned char max_recv_msg_size;
272 unsigned int multi_support;
275 #define SSIF_NO_MULTI 0
276 #define SSIF_MULTI_2_PART 1
277 #define SSIF_MULTI_n_PART 2
278 unsigned char *multi_data;
279 unsigned int multi_len;
280 unsigned int multi_pos;
282 atomic_t stats[SSIF_NUM_STATS];
285 #define ssif_inc_stat(ssif, stat) \
286 atomic_inc(&(ssif)->stats[SSIF_STAT_ ## stat])
287 #define ssif_get_stat(ssif, stat) \
288 ((unsigned int) atomic_read(&(ssif)->stats[SSIF_STAT_ ## stat]))
290 static bool initialized;
292 static void return_hosed_msg(struct ssif_info *ssif_info,
293 struct ipmi_smi_msg *msg);
294 static void start_next_msg(struct ssif_info *ssif_info, unsigned long *flags);
295 static int start_send(struct ssif_info *ssif_info,
299 static unsigned long *ipmi_ssif_lock_cond(struct ssif_info *ssif_info,
300 unsigned long *flags)
302 spin_lock_irqsave(&ssif_info->lock, *flags);
306 static void ipmi_ssif_unlock_cond(struct ssif_info *ssif_info,
307 unsigned long *flags)
309 spin_unlock_irqrestore(&ssif_info->lock, *flags);
312 static void deliver_recv_msg(struct ssif_info *ssif_info,
313 struct ipmi_smi_msg *msg)
315 if (msg->rsp_size < 0) {
316 return_hosed_msg(ssif_info, msg);
318 "Malformed message in deliver_recv_msg: rsp_size = %d\n",
321 ipmi_smi_msg_received(ssif_info->intf, msg);
325 static void return_hosed_msg(struct ssif_info *ssif_info,
326 struct ipmi_smi_msg *msg)
328 ssif_inc_stat(ssif_info, hosed);
330 /* Make it a response */
331 msg->rsp[0] = msg->data[0] | 4;
332 msg->rsp[1] = msg->data[1];
333 msg->rsp[2] = 0xFF; /* Unknown error. */
336 deliver_recv_msg(ssif_info, msg);
340 * Must be called with the message lock held. This will release the
341 * message lock. Note that the caller will check SSIF_IDLE and start a
342 * new operation, so there is no need to check for new messages to
345 static void start_clear_flags(struct ssif_info *ssif_info, unsigned long *flags)
347 unsigned char msg[3];
349 ssif_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
350 ssif_info->ssif_state = SSIF_CLEARING_FLAGS;
351 ipmi_ssif_unlock_cond(ssif_info, flags);
353 /* Make sure the watchdog pre-timeout flag is not set at startup. */
354 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
355 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
356 msg[2] = WDT_PRE_TIMEOUT_INT;
358 if (start_send(ssif_info, msg, 3) != 0) {
359 /* Error, just go to normal state. */
360 ssif_info->ssif_state = SSIF_NORMAL;
364 static void start_flag_fetch(struct ssif_info *ssif_info, unsigned long *flags)
368 ssif_info->req_flags = false;
369 ssif_info->ssif_state = SSIF_GETTING_FLAGS;
370 ipmi_ssif_unlock_cond(ssif_info, flags);
372 mb[0] = (IPMI_NETFN_APP_REQUEST << 2);
373 mb[1] = IPMI_GET_MSG_FLAGS_CMD;
374 if (start_send(ssif_info, mb, 2) != 0)
375 ssif_info->ssif_state = SSIF_NORMAL;
378 static void check_start_send(struct ssif_info *ssif_info, unsigned long *flags,
379 struct ipmi_smi_msg *msg)
381 if (start_send(ssif_info, msg->data, msg->data_size) != 0) {
382 unsigned long oflags;
384 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
385 ssif_info->curr_msg = NULL;
386 ssif_info->ssif_state = SSIF_NORMAL;
387 ipmi_ssif_unlock_cond(ssif_info, flags);
388 ipmi_free_smi_msg(msg);
392 static void start_event_fetch(struct ssif_info *ssif_info, unsigned long *flags)
394 struct ipmi_smi_msg *msg;
396 ssif_info->req_events = false;
398 msg = ipmi_alloc_smi_msg();
400 ssif_info->ssif_state = SSIF_NORMAL;
401 ipmi_ssif_unlock_cond(ssif_info, flags);
405 ssif_info->curr_msg = msg;
406 ssif_info->ssif_state = SSIF_GETTING_EVENTS;
407 ipmi_ssif_unlock_cond(ssif_info, flags);
409 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
410 msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
413 check_start_send(ssif_info, flags, msg);
416 static void start_recv_msg_fetch(struct ssif_info *ssif_info,
417 unsigned long *flags)
419 struct ipmi_smi_msg *msg;
421 msg = ipmi_alloc_smi_msg();
423 ssif_info->ssif_state = SSIF_NORMAL;
424 ipmi_ssif_unlock_cond(ssif_info, flags);
428 ssif_info->curr_msg = msg;
429 ssif_info->ssif_state = SSIF_GETTING_MESSAGES;
430 ipmi_ssif_unlock_cond(ssif_info, flags);
432 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
433 msg->data[1] = IPMI_GET_MSG_CMD;
436 check_start_send(ssif_info, flags, msg);
440 * Must be called with the message lock held. This will release the
441 * message lock. Note that the caller will check SSIF_IDLE and start a
442 * new operation, so there is no need to check for new messages to
445 static void handle_flags(struct ssif_info *ssif_info, unsigned long *flags)
447 if (ssif_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
448 /* Watchdog pre-timeout */
449 ssif_inc_stat(ssif_info, watchdog_pretimeouts);
450 start_clear_flags(ssif_info, flags);
451 ipmi_smi_watchdog_pretimeout(ssif_info->intf);
452 } else if (ssif_info->msg_flags & RECEIVE_MSG_AVAIL)
453 /* Messages available. */
454 start_recv_msg_fetch(ssif_info, flags);
455 else if (ssif_info->msg_flags & EVENT_MSG_BUFFER_FULL)
456 /* Events available. */
457 start_event_fetch(ssif_info, flags);
459 ssif_info->ssif_state = SSIF_NORMAL;
460 ipmi_ssif_unlock_cond(ssif_info, flags);
464 static int ipmi_ssif_thread(void *data)
466 struct ssif_info *ssif_info = data;
468 while (!kthread_should_stop()) {
471 /* Wait for something to do */
472 result = wait_for_completion_interruptible(
473 &ssif_info->wake_thread);
474 if (ssif_info->stopping)
476 if (result == -ERESTARTSYS)
478 init_completion(&ssif_info->wake_thread);
480 if (ssif_info->i2c_read_write == I2C_SMBUS_WRITE) {
481 result = i2c_smbus_write_block_data(
482 ssif_info->client, ssif_info->i2c_command,
483 ssif_info->i2c_data[0],
484 ssif_info->i2c_data + 1);
485 ssif_info->done_handler(ssif_info, result, NULL, 0);
487 result = i2c_smbus_read_block_data(
488 ssif_info->client, ssif_info->i2c_command,
489 ssif_info->i2c_data);
491 ssif_info->done_handler(ssif_info, result,
494 ssif_info->done_handler(ssif_info, 0,
503 static int ssif_i2c_send(struct ssif_info *ssif_info,
504 ssif_i2c_done handler,
505 int read_write, int command,
506 unsigned char *data, unsigned int size)
508 ssif_info->done_handler = handler;
510 ssif_info->i2c_read_write = read_write;
511 ssif_info->i2c_command = command;
512 ssif_info->i2c_data = data;
513 ssif_info->i2c_size = size;
514 complete(&ssif_info->wake_thread);
519 static void msg_done_handler(struct ssif_info *ssif_info, int result,
520 unsigned char *data, unsigned int len);
522 static void start_get(struct ssif_info *ssif_info)
526 ssif_info->rtc_us_timer = 0;
527 ssif_info->multi_pos = 0;
529 rv = ssif_i2c_send(ssif_info, msg_done_handler, I2C_SMBUS_READ,
531 ssif_info->recv, I2C_SMBUS_BLOCK_DATA);
533 /* request failed, just return the error. */
534 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
535 pr_info("Error from i2c_non_blocking_op(5)\n");
537 msg_done_handler(ssif_info, -EIO, NULL, 0);
541 static void retry_timeout(struct timer_list *t)
543 struct ssif_info *ssif_info = from_timer(ssif_info, t, retry_timer);
544 unsigned long oflags, *flags;
547 if (ssif_info->stopping)
550 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
551 waiting = ssif_info->waiting_alert;
552 ssif_info->waiting_alert = false;
553 ipmi_ssif_unlock_cond(ssif_info, flags);
556 start_get(ssif_info);
560 static void ssif_alert(struct i2c_client *client, enum i2c_alert_protocol type,
563 struct ssif_info *ssif_info = i2c_get_clientdata(client);
564 unsigned long oflags, *flags;
567 if (type != I2C_PROTOCOL_SMBUS_ALERT)
570 ssif_inc_stat(ssif_info, alerts);
572 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
573 if (ssif_info->waiting_alert) {
574 ssif_info->waiting_alert = false;
575 del_timer(&ssif_info->retry_timer);
577 } else if (ssif_info->curr_msg) {
578 ssif_info->got_alert = true;
580 ipmi_ssif_unlock_cond(ssif_info, flags);
582 start_get(ssif_info);
585 static int start_resend(struct ssif_info *ssif_info);
587 static void msg_done_handler(struct ssif_info *ssif_info, int result,
588 unsigned char *data, unsigned int len)
590 struct ipmi_smi_msg *msg;
591 unsigned long oflags, *flags;
595 * We are single-threaded here, so no need for a lock until we
596 * start messing with driver states or the queues.
600 ssif_info->retries_left--;
601 if (ssif_info->retries_left > 0) {
602 ssif_inc_stat(ssif_info, receive_retries);
604 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
605 ssif_info->waiting_alert = true;
606 ssif_info->rtc_us_timer = SSIF_MSG_USEC;
607 mod_timer(&ssif_info->retry_timer,
608 jiffies + SSIF_MSG_JIFFIES);
609 ipmi_ssif_unlock_cond(ssif_info, flags);
613 ssif_inc_stat(ssif_info, receive_errors);
615 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
616 pr_info("Error in msg_done_handler: %d\n", result);
621 if ((len > 1) && (ssif_info->multi_pos == 0)
622 && (data[0] == 0x00) && (data[1] == 0x01)) {
623 /* Start of multi-part read. Start the next transaction. */
626 ssif_inc_stat(ssif_info, received_message_parts);
628 /* Remove the multi-part read marker. */
630 for (i = 0; i < len; i++)
631 ssif_info->data[i] = data[i+2];
632 ssif_info->multi_len = len;
633 ssif_info->multi_pos = 1;
635 rv = ssif_i2c_send(ssif_info, msg_done_handler, I2C_SMBUS_READ,
636 SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE,
637 ssif_info->recv, I2C_SMBUS_BLOCK_DATA);
639 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
640 pr_info("Error from i2c_non_blocking_op(1)\n");
645 } else if (ssif_info->multi_pos) {
646 /* Middle of multi-part read. Start the next transaction. */
648 unsigned char blocknum;
652 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
653 pr_info(PFX "Middle message with no data\n");
660 if (ssif_info->multi_len + len - 1 > IPMI_MAX_MSG_LENGTH) {
661 /* Received message too big, abort the operation. */
663 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
664 pr_info("Received message too big\n");
669 /* Remove the blocknum from the data. */
671 for (i = 0; i < len; i++)
672 ssif_info->data[i + ssif_info->multi_len] = data[i + 1];
673 ssif_info->multi_len += len;
674 if (blocknum == 0xff) {
676 len = ssif_info->multi_len;
677 data = ssif_info->data;
678 } else if (blocknum + 1 != ssif_info->multi_pos) {
680 * Out of sequence block, just abort. Block
681 * numbers start at zero for the second block,
682 * but multi_pos starts at one, so the +1.
686 ssif_inc_stat(ssif_info, received_message_parts);
688 ssif_info->multi_pos++;
690 rv = ssif_i2c_send(ssif_info, msg_done_handler,
692 SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE,
694 I2C_SMBUS_BLOCK_DATA);
696 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
698 "Error from ssif_i2c_send\n");
707 ssif_inc_stat(ssif_info, receive_errors);
709 ssif_inc_stat(ssif_info, received_messages);
710 ssif_inc_stat(ssif_info, received_message_parts);
715 if (ssif_info->ssif_debug & SSIF_DEBUG_STATE)
716 pr_info(PFX "DONE 1: state = %d, result=%d.\n",
717 ssif_info->ssif_state, result);
719 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
720 msg = ssif_info->curr_msg;
723 if (msg->rsp_size > IPMI_MAX_MSG_LENGTH)
724 msg->rsp_size = IPMI_MAX_MSG_LENGTH;
725 memcpy(msg->rsp, data, msg->rsp_size);
726 ssif_info->curr_msg = NULL;
729 switch (ssif_info->ssif_state) {
731 ipmi_ssif_unlock_cond(ssif_info, flags);
736 return_hosed_msg(ssif_info, msg);
738 deliver_recv_msg(ssif_info, msg);
741 case SSIF_GETTING_FLAGS:
742 /* We got the flags from the SSIF, now handle them. */
743 if ((result < 0) || (len < 4) || (data[2] != 0)) {
745 * Error fetching flags, or invalid length,
746 * just give up for now.
748 ssif_info->ssif_state = SSIF_NORMAL;
749 ipmi_ssif_unlock_cond(ssif_info, flags);
750 pr_warn(PFX "Error getting flags: %d %d, %x\n",
751 result, len, (len >= 3) ? data[2] : 0);
752 } else if (data[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
753 || data[1] != IPMI_GET_MSG_FLAGS_CMD) {
755 * Don't abort here, maybe it was a queued
756 * response to a previous command.
758 ipmi_ssif_unlock_cond(ssif_info, flags);
759 pr_warn(PFX "Invalid response getting flags: %x %x\n",
762 ssif_inc_stat(ssif_info, flag_fetches);
763 ssif_info->msg_flags = data[3];
764 handle_flags(ssif_info, flags);
768 case SSIF_CLEARING_FLAGS:
769 /* We cleared the flags. */
770 if ((result < 0) || (len < 3) || (data[2] != 0)) {
771 /* Error clearing flags */
772 pr_warn(PFX "Error clearing flags: %d %d, %x\n",
773 result, len, (len >= 3) ? data[2] : 0);
774 } else if (data[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
775 || data[1] != IPMI_CLEAR_MSG_FLAGS_CMD) {
776 pr_warn(PFX "Invalid response clearing flags: %x %x\n",
779 ssif_info->ssif_state = SSIF_NORMAL;
780 ipmi_ssif_unlock_cond(ssif_info, flags);
783 case SSIF_GETTING_EVENTS:
784 if ((result < 0) || (len < 3) || (msg->rsp[2] != 0)) {
785 /* Error getting event, probably done. */
788 /* Take off the event flag. */
789 ssif_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
790 handle_flags(ssif_info, flags);
791 } else if (msg->rsp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
792 || msg->rsp[1] != IPMI_READ_EVENT_MSG_BUFFER_CMD) {
793 pr_warn(PFX "Invalid response getting events: %x %x\n",
794 msg->rsp[0], msg->rsp[1]);
796 /* Take off the event flag. */
797 ssif_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
798 handle_flags(ssif_info, flags);
800 handle_flags(ssif_info, flags);
801 ssif_inc_stat(ssif_info, events);
802 deliver_recv_msg(ssif_info, msg);
806 case SSIF_GETTING_MESSAGES:
807 if ((result < 0) || (len < 3) || (msg->rsp[2] != 0)) {
808 /* Error getting event, probably done. */
811 /* Take off the msg flag. */
812 ssif_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
813 handle_flags(ssif_info, flags);
814 } else if (msg->rsp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
815 || msg->rsp[1] != IPMI_GET_MSG_CMD) {
816 pr_warn(PFX "Invalid response clearing flags: %x %x\n",
817 msg->rsp[0], msg->rsp[1]);
820 /* Take off the msg flag. */
821 ssif_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
822 handle_flags(ssif_info, flags);
824 ssif_inc_stat(ssif_info, incoming_messages);
825 handle_flags(ssif_info, flags);
826 deliver_recv_msg(ssif_info, msg);
831 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
832 if (SSIF_IDLE(ssif_info) && !ssif_info->stopping) {
833 if (ssif_info->req_events)
834 start_event_fetch(ssif_info, flags);
835 else if (ssif_info->req_flags)
836 start_flag_fetch(ssif_info, flags);
838 start_next_msg(ssif_info, flags);
840 ipmi_ssif_unlock_cond(ssif_info, flags);
842 if (ssif_info->ssif_debug & SSIF_DEBUG_STATE)
843 pr_info(PFX "DONE 2: state = %d.\n", ssif_info->ssif_state);
846 static void msg_written_handler(struct ssif_info *ssif_info, int result,
847 unsigned char *data, unsigned int len)
851 /* We are single-threaded here, so no need for a lock. */
853 ssif_info->retries_left--;
854 if (ssif_info->retries_left > 0) {
855 if (!start_resend(ssif_info)) {
856 ssif_inc_stat(ssif_info, send_retries);
859 /* request failed, just return the error. */
860 ssif_inc_stat(ssif_info, send_errors);
862 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
864 "Out of retries in msg_written_handler\n");
865 msg_done_handler(ssif_info, -EIO, NULL, 0);
869 ssif_inc_stat(ssif_info, send_errors);
872 * Got an error on transmit, let the done routine
875 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
876 pr_info("Error in msg_written_handler: %d\n", result);
878 msg_done_handler(ssif_info, result, NULL, 0);
882 if (ssif_info->multi_data) {
884 * In the middle of a multi-data write. See the comment
885 * in the SSIF_MULTI_n_PART case in the probe function
886 * for details on the intricacies of this.
889 unsigned char *data_to_send;
891 ssif_inc_stat(ssif_info, sent_messages_parts);
893 left = ssif_info->multi_len - ssif_info->multi_pos;
897 ssif_info->multi_data[ssif_info->multi_pos] = left;
898 data_to_send = ssif_info->multi_data + ssif_info->multi_pos;
899 ssif_info->multi_pos += left;
902 * Write is finished. Note that we must end
903 * with a write of less than 32 bytes to
904 * complete the transaction, even if it is
907 ssif_info->multi_data = NULL;
909 rv = ssif_i2c_send(ssif_info, msg_written_handler,
911 SSIF_IPMI_MULTI_PART_REQUEST_MIDDLE,
913 I2C_SMBUS_BLOCK_DATA);
915 /* request failed, just return the error. */
916 ssif_inc_stat(ssif_info, send_errors);
918 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
919 pr_info("Error from i2c_non_blocking_op(3)\n");
920 msg_done_handler(ssif_info, -EIO, NULL, 0);
923 /* Ready to request the result. */
924 unsigned long oflags, *flags;
926 ssif_inc_stat(ssif_info, sent_messages);
927 ssif_inc_stat(ssif_info, sent_messages_parts);
929 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
930 if (ssif_info->got_alert) {
931 /* The result is already ready, just start it. */
932 ssif_info->got_alert = false;
933 ipmi_ssif_unlock_cond(ssif_info, flags);
934 start_get(ssif_info);
936 /* Wait a jiffie then request the next message */
937 ssif_info->waiting_alert = true;
938 ssif_info->retries_left = SSIF_RECV_RETRIES;
939 ssif_info->rtc_us_timer = SSIF_MSG_PART_USEC;
940 mod_timer(&ssif_info->retry_timer,
941 jiffies + SSIF_MSG_PART_JIFFIES);
942 ipmi_ssif_unlock_cond(ssif_info, flags);
947 static int start_resend(struct ssif_info *ssif_info)
952 ssif_info->got_alert = false;
954 if (ssif_info->data_len > 32) {
955 command = SSIF_IPMI_MULTI_PART_REQUEST_START;
956 ssif_info->multi_data = ssif_info->data;
957 ssif_info->multi_len = ssif_info->data_len;
959 * Subtle thing, this is 32, not 33, because we will
960 * overwrite the thing at position 32 (which was just
961 * transmitted) with the new length.
963 ssif_info->multi_pos = 32;
964 ssif_info->data[0] = 32;
966 ssif_info->multi_data = NULL;
967 command = SSIF_IPMI_REQUEST;
968 ssif_info->data[0] = ssif_info->data_len;
971 rv = ssif_i2c_send(ssif_info, msg_written_handler, I2C_SMBUS_WRITE,
972 command, ssif_info->data, I2C_SMBUS_BLOCK_DATA);
973 if (rv && (ssif_info->ssif_debug & SSIF_DEBUG_MSG))
974 pr_info("Error from i2c_non_blocking_op(4)\n");
978 static int start_send(struct ssif_info *ssif_info,
982 if (len > IPMI_MAX_MSG_LENGTH)
984 if (len > ssif_info->max_xmit_msg_size)
987 ssif_info->retries_left = SSIF_SEND_RETRIES;
988 memcpy(ssif_info->data + 1, data, len);
989 ssif_info->data_len = len;
990 return start_resend(ssif_info);
993 /* Must be called with the message lock held. */
994 static void start_next_msg(struct ssif_info *ssif_info, unsigned long *flags)
996 struct ipmi_smi_msg *msg;
997 unsigned long oflags;
1000 if (!SSIF_IDLE(ssif_info)) {
1001 ipmi_ssif_unlock_cond(ssif_info, flags);
1005 if (!ssif_info->waiting_msg) {
1006 ssif_info->curr_msg = NULL;
1007 ipmi_ssif_unlock_cond(ssif_info, flags);
1011 ssif_info->curr_msg = ssif_info->waiting_msg;
1012 ssif_info->waiting_msg = NULL;
1013 ipmi_ssif_unlock_cond(ssif_info, flags);
1014 rv = start_send(ssif_info,
1015 ssif_info->curr_msg->data,
1016 ssif_info->curr_msg->data_size);
1018 msg = ssif_info->curr_msg;
1019 ssif_info->curr_msg = NULL;
1020 return_hosed_msg(ssif_info, msg);
1021 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1027 static void sender(void *send_info,
1028 struct ipmi_smi_msg *msg)
1030 struct ssif_info *ssif_info = (struct ssif_info *) send_info;
1031 unsigned long oflags, *flags;
1033 BUG_ON(ssif_info->waiting_msg);
1034 ssif_info->waiting_msg = msg;
1036 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1037 start_next_msg(ssif_info, flags);
1039 if (ssif_info->ssif_debug & SSIF_DEBUG_TIMING) {
1040 struct timespec64 t;
1042 ktime_get_real_ts64(&t);
1043 pr_info("**Enqueue %02x %02x: %lld.%6.6ld\n",
1044 msg->data[0], msg->data[1],
1045 (long long) t.tv_sec, (long) t.tv_nsec / NSEC_PER_USEC);
1049 static int get_smi_info(void *send_info, struct ipmi_smi_info *data)
1051 struct ssif_info *ssif_info = send_info;
1053 data->addr_src = ssif_info->addr_source;
1054 data->dev = &ssif_info->client->dev;
1055 data->addr_info = ssif_info->addr_info;
1056 get_device(data->dev);
1062 * Instead of having our own timer to periodically check the message
1063 * flags, we let the message handler drive us.
1065 static void request_events(void *send_info)
1067 struct ssif_info *ssif_info = (struct ssif_info *) send_info;
1068 unsigned long oflags, *flags;
1070 if (!ssif_info->has_event_buffer)
1073 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1075 * Request flags first, not events, because the lower layer
1076 * doesn't have a way to send an attention. But make sure
1077 * event checking still happens.
1079 ssif_info->req_events = true;
1080 if (SSIF_IDLE(ssif_info))
1081 start_flag_fetch(ssif_info, flags);
1083 ssif_info->req_flags = true;
1084 ipmi_ssif_unlock_cond(ssif_info, flags);
1088 static int ssif_start_processing(void *send_info,
1089 struct ipmi_smi *intf)
1091 struct ssif_info *ssif_info = send_info;
1093 ssif_info->intf = intf;
1098 #define MAX_SSIF_BMCS 4
1100 static unsigned short addr[MAX_SSIF_BMCS];
1101 static int num_addrs;
1102 module_param_array(addr, ushort, &num_addrs, 0);
1103 MODULE_PARM_DESC(addr, "The addresses to scan for IPMI BMCs on the SSIFs.");
1105 static char *adapter_name[MAX_SSIF_BMCS];
1106 static int num_adapter_names;
1107 module_param_array(adapter_name, charp, &num_adapter_names, 0);
1108 MODULE_PARM_DESC(adapter_name, "The string name of the I2C device that has the BMC. By default all devices are scanned.");
1110 static int slave_addrs[MAX_SSIF_BMCS];
1111 static int num_slave_addrs;
1112 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1113 MODULE_PARM_DESC(slave_addrs,
1114 "The default IPMB slave address for the controller.");
1116 static bool alerts_broken;
1117 module_param(alerts_broken, bool, 0);
1118 MODULE_PARM_DESC(alerts_broken, "Don't enable alerts for the controller.");
1121 * Bit 0 enables message debugging, bit 1 enables state debugging, and
1122 * bit 2 enables timing debugging. This is an array indexed by
1125 static int dbg[MAX_SSIF_BMCS];
1127 module_param_array(dbg, int, &num_dbg, 0);
1128 MODULE_PARM_DESC(dbg, "Turn on debugging.");
1130 static bool ssif_dbg_probe;
1131 module_param_named(dbg_probe, ssif_dbg_probe, bool, 0);
1132 MODULE_PARM_DESC(dbg_probe, "Enable debugging of probing of adapters.");
1134 static bool ssif_tryacpi = true;
1135 module_param_named(tryacpi, ssif_tryacpi, bool, 0);
1136 MODULE_PARM_DESC(tryacpi, "Setting this to zero will disable the default scan of the interfaces identified via ACPI");
1138 static bool ssif_trydmi = true;
1139 module_param_named(trydmi, ssif_trydmi, bool, 0);
1140 MODULE_PARM_DESC(trydmi, "Setting this to zero will disable the default scan of the interfaces identified via DMI (SMBIOS)");
1142 static DEFINE_MUTEX(ssif_infos_mutex);
1143 static LIST_HEAD(ssif_infos);
1145 #define IPMI_SSIF_ATTR(name) \
1146 static ssize_t ipmi_##name##_show(struct device *dev, \
1147 struct device_attribute *attr, \
1150 struct ssif_info *ssif_info = dev_get_drvdata(dev); \
1152 return snprintf(buf, 10, "%u\n", ssif_get_stat(ssif_info, name));\
1154 static DEVICE_ATTR(name, S_IRUGO, ipmi_##name##_show, NULL)
1156 static ssize_t ipmi_type_show(struct device *dev,
1157 struct device_attribute *attr,
1160 return snprintf(buf, 10, "ssif\n");
1162 static DEVICE_ATTR(type, S_IRUGO, ipmi_type_show, NULL);
1164 IPMI_SSIF_ATTR(sent_messages);
1165 IPMI_SSIF_ATTR(sent_messages_parts);
1166 IPMI_SSIF_ATTR(send_retries);
1167 IPMI_SSIF_ATTR(send_errors);
1168 IPMI_SSIF_ATTR(received_messages);
1169 IPMI_SSIF_ATTR(received_message_parts);
1170 IPMI_SSIF_ATTR(receive_retries);
1171 IPMI_SSIF_ATTR(receive_errors);
1172 IPMI_SSIF_ATTR(flag_fetches);
1173 IPMI_SSIF_ATTR(hosed);
1174 IPMI_SSIF_ATTR(events);
1175 IPMI_SSIF_ATTR(watchdog_pretimeouts);
1176 IPMI_SSIF_ATTR(alerts);
1178 static struct attribute *ipmi_ssif_dev_attrs[] = {
1179 &dev_attr_type.attr,
1180 &dev_attr_sent_messages.attr,
1181 &dev_attr_sent_messages_parts.attr,
1182 &dev_attr_send_retries.attr,
1183 &dev_attr_send_errors.attr,
1184 &dev_attr_received_messages.attr,
1185 &dev_attr_received_message_parts.attr,
1186 &dev_attr_receive_retries.attr,
1187 &dev_attr_receive_errors.attr,
1188 &dev_attr_flag_fetches.attr,
1189 &dev_attr_hosed.attr,
1190 &dev_attr_events.attr,
1191 &dev_attr_watchdog_pretimeouts.attr,
1192 &dev_attr_alerts.attr,
1196 static const struct attribute_group ipmi_ssif_dev_attr_group = {
1197 .attrs = ipmi_ssif_dev_attrs,
1200 static void shutdown_ssif(void *send_info)
1202 struct ssif_info *ssif_info = send_info;
1204 device_remove_group(&ssif_info->client->dev, &ipmi_ssif_dev_attr_group);
1205 dev_set_drvdata(&ssif_info->client->dev, NULL);
1207 /* make sure the driver is not looking for flags any more. */
1208 while (ssif_info->ssif_state != SSIF_NORMAL)
1209 schedule_timeout(1);
1211 ssif_info->stopping = true;
1212 del_timer_sync(&ssif_info->retry_timer);
1213 if (ssif_info->thread) {
1214 complete(&ssif_info->wake_thread);
1215 kthread_stop(ssif_info->thread);
1219 * No message can be outstanding now, we have removed the
1220 * upper layer and it permitted us to do so.
1225 static int ssif_remove(struct i2c_client *client)
1227 struct ssif_info *ssif_info = i2c_get_clientdata(client);
1228 struct ipmi_smi *intf;
1229 struct ssif_addr_info *addr_info;
1235 * After this point, we won't deliver anything asychronously
1236 * to the message handler. We can unregister ourself.
1238 intf = ssif_info->intf;
1239 ssif_info->intf = NULL;
1240 ipmi_unregister_smi(intf);
1242 list_for_each_entry(addr_info, &ssif_infos, link) {
1243 if (addr_info->client == client) {
1244 addr_info->client = NULL;
1252 static int do_cmd(struct i2c_client *client, int len, unsigned char *msg,
1253 int *resp_len, unsigned char *resp)
1258 retry_cnt = SSIF_SEND_RETRIES;
1260 ret = i2c_smbus_write_block_data(client, SSIF_IPMI_REQUEST, len, msg);
1269 retry_cnt = SSIF_RECV_RETRIES;
1270 while (retry_cnt > 0) {
1271 ret = i2c_smbus_read_block_data(client, SSIF_IPMI_RESPONSE,
1275 msleep(SSIF_MSG_MSEC);
1282 /* Validate that the response is correct. */
1284 (resp[0] != (msg[0] | (1 << 2))) ||
1285 (resp[1] != msg[1]))
1296 static int ssif_detect(struct i2c_client *client, struct i2c_board_info *info)
1298 unsigned char *resp;
1299 unsigned char msg[3];
1303 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1307 /* Do a Get Device ID command, since it is required. */
1308 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1309 msg[1] = IPMI_GET_DEVICE_ID_CMD;
1310 rv = do_cmd(client, 2, msg, &len, resp);
1314 strlcpy(info->type, DEVICE_NAME, I2C_NAME_SIZE);
1319 static int strcmp_nospace(char *s1, char *s2)
1321 while (*s1 && *s2) {
1322 while (isspace(*s1))
1324 while (isspace(*s2))
1336 static struct ssif_addr_info *ssif_info_find(unsigned short addr,
1338 bool match_null_name)
1340 struct ssif_addr_info *info, *found = NULL;
1343 list_for_each_entry(info, &ssif_infos, link) {
1344 if (info->binfo.addr == addr) {
1345 if (info->adapter_name || adapter_name) {
1346 if (!info->adapter_name != !adapter_name) {
1347 /* One is NULL and one is not */
1351 strcmp_nospace(info->adapter_name,
1353 /* Names do not match */
1361 if (!found && match_null_name) {
1362 /* Try to get an exact match first, then try with a NULL name */
1363 adapter_name = NULL;
1364 match_null_name = false;
1371 static bool check_acpi(struct ssif_info *ssif_info, struct device *dev)
1374 acpi_handle acpi_handle;
1376 acpi_handle = ACPI_HANDLE(dev);
1378 ssif_info->addr_source = SI_ACPI;
1379 ssif_info->addr_info.acpi_info.acpi_handle = acpi_handle;
1386 static int find_slave_address(struct i2c_client *client, int slave_addr)
1388 #ifdef CONFIG_IPMI_DMI_DECODE
1390 slave_addr = ipmi_dmi_get_slave_addr(
1392 i2c_adapter_id(client->adapter),
1400 * Global enables we care about.
1402 #define GLOBAL_ENABLES_MASK (IPMI_BMC_EVT_MSG_BUFF | IPMI_BMC_RCV_MSG_INTR | \
1403 IPMI_BMC_EVT_MSG_INTR)
1405 static int ssif_probe(struct i2c_client *client, const struct i2c_device_id *id)
1407 unsigned char msg[3];
1408 unsigned char *resp;
1409 struct ssif_info *ssif_info;
1414 struct ssif_addr_info *addr_info = NULL;
1416 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1420 ssif_info = kzalloc(sizeof(*ssif_info), GFP_KERNEL);
1426 if (!check_acpi(ssif_info, &client->dev)) {
1427 addr_info = ssif_info_find(client->addr, client->adapter->name,
1430 /* Must have come in through sysfs. */
1431 ssif_info->addr_source = SI_HOTMOD;
1433 ssif_info->addr_source = addr_info->addr_src;
1434 ssif_info->ssif_debug = addr_info->debug;
1435 ssif_info->addr_info = addr_info->addr_info;
1436 addr_info->client = client;
1437 slave_addr = addr_info->slave_addr;
1441 slave_addr = find_slave_address(client, slave_addr);
1443 pr_info(PFX "Trying %s-specified SSIF interface at i2c address 0x%x, adapter %s, slave address 0x%x\n",
1444 ipmi_addr_src_to_str(ssif_info->addr_source),
1445 client->addr, client->adapter->name, slave_addr);
1447 ssif_info->client = client;
1448 i2c_set_clientdata(client, ssif_info);
1450 /* Now check for system interface capabilities */
1451 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1452 msg[1] = IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_CMD;
1453 msg[2] = 0; /* SSIF */
1454 rv = do_cmd(client, 3, msg, &len, resp);
1455 if (!rv && (len >= 3) && (resp[2] == 0)) {
1458 pr_info(PFX "SSIF info too short: %d\n", len);
1462 /* Got a good SSIF response, handle it. */
1463 ssif_info->max_xmit_msg_size = resp[5];
1464 ssif_info->max_recv_msg_size = resp[6];
1465 ssif_info->multi_support = (resp[4] >> 6) & 0x3;
1466 ssif_info->supports_pec = (resp[4] >> 3) & 0x1;
1468 /* Sanitize the data */
1469 switch (ssif_info->multi_support) {
1471 if (ssif_info->max_xmit_msg_size > 32)
1472 ssif_info->max_xmit_msg_size = 32;
1473 if (ssif_info->max_recv_msg_size > 32)
1474 ssif_info->max_recv_msg_size = 32;
1477 case SSIF_MULTI_2_PART:
1478 if (ssif_info->max_xmit_msg_size > 63)
1479 ssif_info->max_xmit_msg_size = 63;
1480 if (ssif_info->max_recv_msg_size > 62)
1481 ssif_info->max_recv_msg_size = 62;
1484 case SSIF_MULTI_n_PART:
1486 * The specification is rather confusing at
1487 * this point, but I think I understand what
1488 * is meant. At least I have a workable
1489 * solution. With multi-part messages, you
1490 * cannot send a message that is a multiple of
1491 * 32-bytes in length, because the start and
1492 * middle messages are 32-bytes and the end
1493 * message must be at least one byte. You
1494 * can't fudge on an extra byte, that would
1495 * screw up things like fru data writes. So
1496 * we limit the length to 63 bytes. That way
1497 * a 32-byte message gets sent as a single
1498 * part. A larger message will be a 32-byte
1499 * start and the next message is always going
1500 * to be 1-31 bytes in length. Not ideal, but
1503 if (ssif_info->max_xmit_msg_size > 63)
1504 ssif_info->max_xmit_msg_size = 63;
1508 /* Data is not sane, just give up. */
1513 /* Assume no multi-part or PEC support */
1514 pr_info(PFX "Error fetching SSIF: %d %d %2.2x, your system probably doesn't support this command so using defaults\n",
1517 ssif_info->max_xmit_msg_size = 32;
1518 ssif_info->max_recv_msg_size = 32;
1519 ssif_info->multi_support = SSIF_NO_MULTI;
1520 ssif_info->supports_pec = 0;
1523 /* Make sure the NMI timeout is cleared. */
1524 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1525 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
1526 msg[2] = WDT_PRE_TIMEOUT_INT;
1527 rv = do_cmd(client, 3, msg, &len, resp);
1528 if (rv || (len < 3) || (resp[2] != 0))
1529 pr_warn(PFX "Unable to clear message flags: %d %d %2.2x\n",
1532 /* Attempt to enable the event buffer. */
1533 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1534 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
1535 rv = do_cmd(client, 2, msg, &len, resp);
1536 if (rv || (len < 4) || (resp[2] != 0)) {
1537 pr_warn(PFX "Error getting global enables: %d %d %2.2x\n",
1539 rv = 0; /* Not fatal */
1543 ssif_info->global_enables = resp[3];
1545 if (resp[3] & IPMI_BMC_EVT_MSG_BUFF) {
1546 ssif_info->has_event_buffer = true;
1547 /* buffer is already enabled, nothing to do. */
1551 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1552 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
1553 msg[2] = ssif_info->global_enables | IPMI_BMC_EVT_MSG_BUFF;
1554 rv = do_cmd(client, 3, msg, &len, resp);
1555 if (rv || (len < 2)) {
1556 pr_warn(PFX "Error setting global enables: %d %d %2.2x\n",
1558 rv = 0; /* Not fatal */
1563 /* A successful return means the event buffer is supported. */
1564 ssif_info->has_event_buffer = true;
1565 ssif_info->global_enables |= IPMI_BMC_EVT_MSG_BUFF;
1568 /* Some systems don't behave well if you enable alerts. */
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_RCV_MSG_INTR;
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 alert is supported. */
1585 ssif_info->supports_alert = true;
1586 ssif_info->global_enables |= IPMI_BMC_RCV_MSG_INTR;
1590 if (ssif_dbg_probe) {
1591 pr_info("ssif_probe: i2c_probe found device at i2c address %x\n",
1595 spin_lock_init(&ssif_info->lock);
1596 ssif_info->ssif_state = SSIF_NORMAL;
1597 timer_setup(&ssif_info->retry_timer, retry_timeout, 0);
1599 for (i = 0; i < SSIF_NUM_STATS; i++)
1600 atomic_set(&ssif_info->stats[i], 0);
1602 if (ssif_info->supports_pec)
1603 ssif_info->client->flags |= I2C_CLIENT_PEC;
1605 ssif_info->handlers.owner = THIS_MODULE;
1606 ssif_info->handlers.start_processing = ssif_start_processing;
1607 ssif_info->handlers.shutdown = shutdown_ssif;
1608 ssif_info->handlers.get_smi_info = get_smi_info;
1609 ssif_info->handlers.sender = sender;
1610 ssif_info->handlers.request_events = request_events;
1613 unsigned int thread_num;
1615 thread_num = ((i2c_adapter_id(ssif_info->client->adapter)
1617 ssif_info->client->addr);
1618 init_completion(&ssif_info->wake_thread);
1619 ssif_info->thread = kthread_run(ipmi_ssif_thread, ssif_info,
1620 "kssif%4.4x", thread_num);
1621 if (IS_ERR(ssif_info->thread)) {
1622 rv = PTR_ERR(ssif_info->thread);
1623 dev_notice(&ssif_info->client->dev,
1624 "Could not start kernel thread: error %d\n",
1630 dev_set_drvdata(&ssif_info->client->dev, ssif_info);
1631 rv = device_add_group(&ssif_info->client->dev,
1632 &ipmi_ssif_dev_attr_group);
1634 dev_err(&ssif_info->client->dev,
1635 "Unable to add device attributes: error %d\n",
1640 rv = ipmi_register_smi(&ssif_info->handlers,
1642 &ssif_info->client->dev,
1645 pr_err(PFX "Unable to register device: error %d\n", rv);
1646 goto out_remove_attr;
1652 * Note that if addr_info->client is assigned, we
1653 * leave it. The i2c client hangs around even if we
1654 * return a failure here, and the failure here is not
1655 * propagated back to the i2c code. This seems to be
1656 * design intent, strange as it may be. But if we
1657 * don't leave it, ssif_platform_remove will not remove
1658 * the client like it should.
1660 dev_err(&client->dev, "Unable to start IPMI SSIF: %d\n", rv);
1667 device_remove_group(&ssif_info->client->dev, &ipmi_ssif_dev_attr_group);
1668 dev_set_drvdata(&ssif_info->client->dev, NULL);
1672 static int ssif_adapter_handler(struct device *adev, void *opaque)
1674 struct ssif_addr_info *addr_info = opaque;
1676 if (adev->type != &i2c_adapter_type)
1679 i2c_new_device(to_i2c_adapter(adev), &addr_info->binfo);
1681 if (!addr_info->adapter_name)
1682 return 1; /* Only try the first I2C adapter by default. */
1686 static int new_ssif_client(int addr, char *adapter_name,
1687 int debug, int slave_addr,
1688 enum ipmi_addr_src addr_src,
1691 struct ssif_addr_info *addr_info;
1694 mutex_lock(&ssif_infos_mutex);
1695 if (ssif_info_find(addr, adapter_name, false)) {
1700 addr_info = kzalloc(sizeof(*addr_info), GFP_KERNEL);
1707 addr_info->adapter_name = kstrdup(adapter_name, GFP_KERNEL);
1708 if (!addr_info->adapter_name) {
1715 strncpy(addr_info->binfo.type, DEVICE_NAME,
1716 sizeof(addr_info->binfo.type));
1717 addr_info->binfo.addr = addr;
1718 addr_info->binfo.platform_data = addr_info;
1719 addr_info->debug = debug;
1720 addr_info->slave_addr = slave_addr;
1721 addr_info->addr_src = addr_src;
1722 addr_info->dev = dev;
1725 dev_set_drvdata(dev, addr_info);
1727 list_add_tail(&addr_info->link, &ssif_infos);
1730 i2c_for_each_dev(addr_info, ssif_adapter_handler);
1731 /* Otherwise address list will get it */
1734 mutex_unlock(&ssif_infos_mutex);
1738 static void free_ssif_clients(void)
1740 struct ssif_addr_info *info, *tmp;
1742 mutex_lock(&ssif_infos_mutex);
1743 list_for_each_entry_safe(info, tmp, &ssif_infos, link) {
1744 list_del(&info->link);
1745 kfree(info->adapter_name);
1748 mutex_unlock(&ssif_infos_mutex);
1751 static unsigned short *ssif_address_list(void)
1753 struct ssif_addr_info *info;
1754 unsigned int count = 0, i;
1755 unsigned short *address_list;
1757 list_for_each_entry(info, &ssif_infos, link)
1760 address_list = kzalloc(sizeof(*address_list) * (count + 1), GFP_KERNEL);
1765 list_for_each_entry(info, &ssif_infos, link) {
1766 unsigned short addr = info->binfo.addr;
1769 for (j = 0; j < i; j++) {
1770 if (address_list[j] == addr)
1773 address_list[i] = addr;
1777 address_list[i] = I2C_CLIENT_END;
1779 return address_list;
1783 static const struct acpi_device_id ssif_acpi_match[] = {
1787 MODULE_DEVICE_TABLE(acpi, ssif_acpi_match);
1791 static int dmi_ipmi_probe(struct platform_device *pdev)
1800 rv = device_property_read_u16(&pdev->dev, "i2c-addr", &i2c_addr);
1802 dev_warn(&pdev->dev, PFX "No i2c-addr property\n");
1806 rv = device_property_read_u8(&pdev->dev, "slave-addr", &slave_addr);
1808 dev_warn(&pdev->dev, "device has no slave-addr property");
1810 return new_ssif_client(i2c_addr, NULL, 0,
1811 slave_addr, SI_SMBIOS, &pdev->dev);
1814 static int dmi_ipmi_probe(struct platform_device *pdev)
1820 static const struct i2c_device_id ssif_id[] = {
1824 MODULE_DEVICE_TABLE(i2c, ssif_id);
1826 static struct i2c_driver ssif_i2c_driver = {
1827 .class = I2C_CLASS_HWMON,
1831 .probe = ssif_probe,
1832 .remove = ssif_remove,
1833 .alert = ssif_alert,
1834 .id_table = ssif_id,
1835 .detect = ssif_detect
1838 static int ssif_platform_probe(struct platform_device *dev)
1840 return dmi_ipmi_probe(dev);
1843 static int ssif_platform_remove(struct platform_device *dev)
1845 struct ssif_addr_info *addr_info = dev_get_drvdata(&dev->dev);
1850 mutex_lock(&ssif_infos_mutex);
1851 i2c_unregister_device(addr_info->client);
1853 list_del(&addr_info->link);
1855 mutex_unlock(&ssif_infos_mutex);
1859 static struct platform_driver ipmi_driver = {
1861 .name = DEVICE_NAME,
1863 .probe = ssif_platform_probe,
1864 .remove = ssif_platform_remove,
1867 static int init_ipmi_ssif(void)
1875 pr_info("IPMI SSIF Interface driver\n");
1877 /* build list for i2c from addr list */
1878 for (i = 0; i < num_addrs; i++) {
1879 rv = new_ssif_client(addr[i], adapter_name[i],
1880 dbg[i], slave_addrs[i],
1881 SI_HARDCODED, NULL);
1884 "Couldn't add hardcoded device at addr 0x%x\n",
1889 ssif_i2c_driver.driver.acpi_match_table =
1890 ACPI_PTR(ssif_acpi_match);
1893 rv = platform_driver_register(&ipmi_driver);
1895 pr_err(PFX "Unable to register driver: %d\n", rv);
1898 ssif_i2c_driver.address_list = ssif_address_list();
1900 rv = i2c_add_driver(&ssif_i2c_driver);
1906 module_init(init_ipmi_ssif);
1908 static void cleanup_ipmi_ssif(void)
1913 initialized = false;
1915 i2c_del_driver(&ssif_i2c_driver);
1917 platform_driver_unregister(&ipmi_driver);
1919 free_ssif_clients();
1921 module_exit(cleanup_ipmi_ssif);
1923 MODULE_ALIAS("platform:dmi-ipmi-ssif");
1924 MODULE_AUTHOR("Todd C Davis <todd.c.davis@intel.com>, Corey Minyard <minyard@acm.org>");
1925 MODULE_DESCRIPTION("IPMI driver for management controllers on a SMBus");
1926 MODULE_LICENSE("GPL");