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 i2c_client *added_client;
186 struct mutex clients_mutex;
187 struct list_head clients;
189 struct list_head link;
194 typedef void (*ssif_i2c_done)(struct ssif_info *ssif_info, int result,
195 unsigned char *data, unsigned int len);
198 struct ipmi_smi *intf;
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 struct timer_list retry_timer;
271 /* Info from SSIF cmd */
272 unsigned char max_xmit_msg_size;
273 unsigned char max_recv_msg_size;
274 unsigned int multi_support;
277 #define SSIF_NO_MULTI 0
278 #define SSIF_MULTI_2_PART 1
279 #define SSIF_MULTI_n_PART 2
280 unsigned char *multi_data;
281 unsigned int multi_len;
282 unsigned int multi_pos;
284 atomic_t stats[SSIF_NUM_STATS];
287 #define ssif_inc_stat(ssif, stat) \
288 atomic_inc(&(ssif)->stats[SSIF_STAT_ ## stat])
289 #define ssif_get_stat(ssif, stat) \
290 ((unsigned int) atomic_read(&(ssif)->stats[SSIF_STAT_ ## stat]))
292 static bool initialized;
294 static void return_hosed_msg(struct ssif_info *ssif_info,
295 struct ipmi_smi_msg *msg);
296 static void start_next_msg(struct ssif_info *ssif_info, unsigned long *flags);
297 static int start_send(struct ssif_info *ssif_info,
301 static unsigned long *ipmi_ssif_lock_cond(struct ssif_info *ssif_info,
302 unsigned long *flags)
304 spin_lock_irqsave(&ssif_info->lock, *flags);
308 static void ipmi_ssif_unlock_cond(struct ssif_info *ssif_info,
309 unsigned long *flags)
311 spin_unlock_irqrestore(&ssif_info->lock, *flags);
314 static void deliver_recv_msg(struct ssif_info *ssif_info,
315 struct ipmi_smi_msg *msg)
317 if (msg->rsp_size < 0) {
318 return_hosed_msg(ssif_info, msg);
320 "Malformed message in deliver_recv_msg: rsp_size = %d\n",
323 ipmi_smi_msg_received(ssif_info->intf, msg);
327 static void return_hosed_msg(struct ssif_info *ssif_info,
328 struct ipmi_smi_msg *msg)
330 ssif_inc_stat(ssif_info, hosed);
332 /* Make it a response */
333 msg->rsp[0] = msg->data[0] | 4;
334 msg->rsp[1] = msg->data[1];
335 msg->rsp[2] = 0xFF; /* Unknown error. */
338 deliver_recv_msg(ssif_info, msg);
342 * Must be called with the message lock held. This will release the
343 * message lock. Note that the caller will check SSIF_IDLE and start a
344 * new operation, so there is no need to check for new messages to
347 static void start_clear_flags(struct ssif_info *ssif_info, unsigned long *flags)
349 unsigned char msg[3];
351 ssif_info->msg_flags &= ~WDT_PRE_TIMEOUT_INT;
352 ssif_info->ssif_state = SSIF_CLEARING_FLAGS;
353 ipmi_ssif_unlock_cond(ssif_info, flags);
355 /* Make sure the watchdog pre-timeout flag is not set at startup. */
356 msg[0] = (IPMI_NETFN_APP_REQUEST << 2);
357 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
358 msg[2] = WDT_PRE_TIMEOUT_INT;
360 if (start_send(ssif_info, msg, 3) != 0) {
361 /* Error, just go to normal state. */
362 ssif_info->ssif_state = SSIF_NORMAL;
366 static void start_flag_fetch(struct ssif_info *ssif_info, unsigned long *flags)
370 ssif_info->req_flags = false;
371 ssif_info->ssif_state = SSIF_GETTING_FLAGS;
372 ipmi_ssif_unlock_cond(ssif_info, flags);
374 mb[0] = (IPMI_NETFN_APP_REQUEST << 2);
375 mb[1] = IPMI_GET_MSG_FLAGS_CMD;
376 if (start_send(ssif_info, mb, 2) != 0)
377 ssif_info->ssif_state = SSIF_NORMAL;
380 static void check_start_send(struct ssif_info *ssif_info, unsigned long *flags,
381 struct ipmi_smi_msg *msg)
383 if (start_send(ssif_info, msg->data, msg->data_size) != 0) {
384 unsigned long oflags;
386 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
387 ssif_info->curr_msg = NULL;
388 ssif_info->ssif_state = SSIF_NORMAL;
389 ipmi_ssif_unlock_cond(ssif_info, flags);
390 ipmi_free_smi_msg(msg);
394 static void start_event_fetch(struct ssif_info *ssif_info, unsigned long *flags)
396 struct ipmi_smi_msg *msg;
398 ssif_info->req_events = false;
400 msg = ipmi_alloc_smi_msg();
402 ssif_info->ssif_state = SSIF_NORMAL;
403 ipmi_ssif_unlock_cond(ssif_info, flags);
407 ssif_info->curr_msg = msg;
408 ssif_info->ssif_state = SSIF_GETTING_EVENTS;
409 ipmi_ssif_unlock_cond(ssif_info, flags);
411 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
412 msg->data[1] = IPMI_READ_EVENT_MSG_BUFFER_CMD;
415 check_start_send(ssif_info, flags, msg);
418 static void start_recv_msg_fetch(struct ssif_info *ssif_info,
419 unsigned long *flags)
421 struct ipmi_smi_msg *msg;
423 msg = ipmi_alloc_smi_msg();
425 ssif_info->ssif_state = SSIF_NORMAL;
426 ipmi_ssif_unlock_cond(ssif_info, flags);
430 ssif_info->curr_msg = msg;
431 ssif_info->ssif_state = SSIF_GETTING_MESSAGES;
432 ipmi_ssif_unlock_cond(ssif_info, flags);
434 msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
435 msg->data[1] = IPMI_GET_MSG_CMD;
438 check_start_send(ssif_info, flags, msg);
442 * Must be called with the message lock held. This will release the
443 * message lock. Note that the caller will check SSIF_IDLE and start a
444 * new operation, so there is no need to check for new messages to
447 static void handle_flags(struct ssif_info *ssif_info, unsigned long *flags)
449 if (ssif_info->msg_flags & WDT_PRE_TIMEOUT_INT) {
450 /* Watchdog pre-timeout */
451 ssif_inc_stat(ssif_info, watchdog_pretimeouts);
452 start_clear_flags(ssif_info, flags);
453 ipmi_smi_watchdog_pretimeout(ssif_info->intf);
454 } else if (ssif_info->msg_flags & RECEIVE_MSG_AVAIL)
455 /* Messages available. */
456 start_recv_msg_fetch(ssif_info, flags);
457 else if (ssif_info->msg_flags & EVENT_MSG_BUFFER_FULL)
458 /* Events available. */
459 start_event_fetch(ssif_info, flags);
461 ssif_info->ssif_state = SSIF_NORMAL;
462 ipmi_ssif_unlock_cond(ssif_info, flags);
466 static int ipmi_ssif_thread(void *data)
468 struct ssif_info *ssif_info = data;
470 while (!kthread_should_stop()) {
473 /* Wait for something to do */
474 result = wait_for_completion_interruptible(
475 &ssif_info->wake_thread);
476 if (ssif_info->stopping)
478 if (result == -ERESTARTSYS)
480 init_completion(&ssif_info->wake_thread);
482 if (ssif_info->i2c_read_write == I2C_SMBUS_WRITE) {
483 result = i2c_smbus_write_block_data(
484 ssif_info->client, ssif_info->i2c_command,
485 ssif_info->i2c_data[0],
486 ssif_info->i2c_data + 1);
487 ssif_info->done_handler(ssif_info, result, NULL, 0);
489 result = i2c_smbus_read_block_data(
490 ssif_info->client, ssif_info->i2c_command,
491 ssif_info->i2c_data);
493 ssif_info->done_handler(ssif_info, result,
496 ssif_info->done_handler(ssif_info, 0,
505 static int ssif_i2c_send(struct ssif_info *ssif_info,
506 ssif_i2c_done handler,
507 int read_write, int command,
508 unsigned char *data, unsigned int size)
510 ssif_info->done_handler = handler;
512 ssif_info->i2c_read_write = read_write;
513 ssif_info->i2c_command = command;
514 ssif_info->i2c_data = data;
515 ssif_info->i2c_size = size;
516 complete(&ssif_info->wake_thread);
521 static void msg_done_handler(struct ssif_info *ssif_info, int result,
522 unsigned char *data, unsigned int len);
524 static void start_get(struct ssif_info *ssif_info)
528 ssif_info->rtc_us_timer = 0;
529 ssif_info->multi_pos = 0;
531 rv = ssif_i2c_send(ssif_info, msg_done_handler, I2C_SMBUS_READ,
533 ssif_info->recv, I2C_SMBUS_BLOCK_DATA);
535 /* request failed, just return the error. */
536 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
537 pr_info("Error from i2c_non_blocking_op(5)\n");
539 msg_done_handler(ssif_info, -EIO, NULL, 0);
543 static void retry_timeout(struct timer_list *t)
545 struct ssif_info *ssif_info = from_timer(ssif_info, t, retry_timer);
546 unsigned long oflags, *flags;
549 if (ssif_info->stopping)
552 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
553 waiting = ssif_info->waiting_alert;
554 ssif_info->waiting_alert = false;
555 ipmi_ssif_unlock_cond(ssif_info, flags);
558 start_get(ssif_info);
562 static void ssif_alert(struct i2c_client *client, enum i2c_alert_protocol type,
565 struct ssif_info *ssif_info = i2c_get_clientdata(client);
566 unsigned long oflags, *flags;
569 if (type != I2C_PROTOCOL_SMBUS_ALERT)
572 ssif_inc_stat(ssif_info, alerts);
574 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
575 if (ssif_info->waiting_alert) {
576 ssif_info->waiting_alert = false;
577 del_timer(&ssif_info->retry_timer);
579 } else if (ssif_info->curr_msg) {
580 ssif_info->got_alert = true;
582 ipmi_ssif_unlock_cond(ssif_info, flags);
584 start_get(ssif_info);
587 static int start_resend(struct ssif_info *ssif_info);
589 static void msg_done_handler(struct ssif_info *ssif_info, int result,
590 unsigned char *data, unsigned int len)
592 struct ipmi_smi_msg *msg;
593 unsigned long oflags, *flags;
597 * We are single-threaded here, so no need for a lock until we
598 * start messing with driver states or the queues.
602 ssif_info->retries_left--;
603 if (ssif_info->retries_left > 0) {
604 ssif_inc_stat(ssif_info, receive_retries);
606 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
607 ssif_info->waiting_alert = true;
608 ssif_info->rtc_us_timer = SSIF_MSG_USEC;
609 if (!ssif_info->stopping)
610 mod_timer(&ssif_info->retry_timer,
611 jiffies + SSIF_MSG_JIFFIES);
612 ipmi_ssif_unlock_cond(ssif_info, flags);
616 ssif_inc_stat(ssif_info, receive_errors);
618 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
619 pr_info("Error in msg_done_handler: %d\n", result);
624 if ((len > 1) && (ssif_info->multi_pos == 0)
625 && (data[0] == 0x00) && (data[1] == 0x01)) {
626 /* Start of multi-part read. Start the next transaction. */
629 ssif_inc_stat(ssif_info, received_message_parts);
631 /* Remove the multi-part read marker. */
634 for (i = 0; i < len; i++)
635 ssif_info->data[i] = data[i];
636 ssif_info->multi_len = len;
637 ssif_info->multi_pos = 1;
639 rv = ssif_i2c_send(ssif_info, msg_done_handler, I2C_SMBUS_READ,
640 SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE,
641 ssif_info->recv, I2C_SMBUS_BLOCK_DATA);
643 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
644 pr_info("Error from i2c_non_blocking_op(1)\n");
649 } else if (ssif_info->multi_pos) {
650 /* Middle of multi-part read. Start the next transaction. */
652 unsigned char blocknum;
656 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
657 pr_info(PFX "Middle message with no data\n");
666 if (blocknum != 0xff && len != 31) {
667 /* All blocks but the last must have 31 data bytes. */
669 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
670 pr_info("Received middle message <31\n");
675 if (ssif_info->multi_len + len > IPMI_MAX_MSG_LENGTH) {
676 /* Received message too big, abort the operation. */
678 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
679 pr_info("Received message too big\n");
684 for (i = 0; i < len; i++)
685 ssif_info->data[i + ssif_info->multi_len] = data[i];
686 ssif_info->multi_len += len;
687 if (blocknum == 0xff) {
689 len = ssif_info->multi_len;
690 data = ssif_info->data;
691 } else if (blocknum + 1 != ssif_info->multi_pos) {
693 * Out of sequence block, just abort. Block
694 * numbers start at zero for the second block,
695 * but multi_pos starts at one, so the +1.
697 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
698 dev_dbg(&ssif_info->client->dev,
699 "Received message out of sequence, expected %u, got %u\n",
700 ssif_info->multi_pos - 1, blocknum);
703 ssif_inc_stat(ssif_info, received_message_parts);
705 ssif_info->multi_pos++;
707 rv = ssif_i2c_send(ssif_info, msg_done_handler,
709 SSIF_IPMI_MULTI_PART_RESPONSE_MIDDLE,
711 I2C_SMBUS_BLOCK_DATA);
713 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
715 "Error from ssif_i2c_send\n");
725 ssif_inc_stat(ssif_info, receive_errors);
727 ssif_inc_stat(ssif_info, received_messages);
728 ssif_inc_stat(ssif_info, received_message_parts);
731 if (ssif_info->ssif_debug & SSIF_DEBUG_STATE)
732 pr_info(PFX "DONE 1: state = %d, result=%d.\n",
733 ssif_info->ssif_state, result);
735 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
736 msg = ssif_info->curr_msg;
739 if (len > IPMI_MAX_MSG_LENGTH)
740 len = IPMI_MAX_MSG_LENGTH;
741 memcpy(msg->rsp, data, len);
746 ssif_info->curr_msg = NULL;
749 switch (ssif_info->ssif_state) {
751 ipmi_ssif_unlock_cond(ssif_info, flags);
756 return_hosed_msg(ssif_info, msg);
758 deliver_recv_msg(ssif_info, msg);
761 case SSIF_GETTING_FLAGS:
762 /* We got the flags from the SSIF, now handle them. */
763 if ((result < 0) || (len < 4) || (data[2] != 0)) {
765 * Error fetching flags, or invalid length,
766 * just give up for now.
768 ssif_info->ssif_state = SSIF_NORMAL;
769 ipmi_ssif_unlock_cond(ssif_info, flags);
770 pr_warn(PFX "Error getting flags: %d %d, %x\n",
771 result, len, (len >= 3) ? data[2] : 0);
772 } else if (data[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
773 || data[1] != IPMI_GET_MSG_FLAGS_CMD) {
775 * Don't abort here, maybe it was a queued
776 * response to a previous command.
778 ipmi_ssif_unlock_cond(ssif_info, flags);
779 pr_warn(PFX "Invalid response getting flags: %x %x\n",
782 ssif_inc_stat(ssif_info, flag_fetches);
783 ssif_info->msg_flags = data[3];
784 handle_flags(ssif_info, flags);
788 case SSIF_CLEARING_FLAGS:
789 /* We cleared the flags. */
790 if ((result < 0) || (len < 3) || (data[2] != 0)) {
791 /* Error clearing flags */
792 pr_warn(PFX "Error clearing flags: %d %d, %x\n",
793 result, len, (len >= 3) ? data[2] : 0);
794 } else if (data[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
795 || data[1] != IPMI_CLEAR_MSG_FLAGS_CMD) {
796 pr_warn(PFX "Invalid response clearing flags: %x %x\n",
799 ssif_info->ssif_state = SSIF_NORMAL;
800 ipmi_ssif_unlock_cond(ssif_info, flags);
803 case SSIF_GETTING_EVENTS:
805 /* Should never happen, but just in case. */
806 dev_warn(&ssif_info->client->dev,
807 "No message set while getting events\n");
808 ipmi_ssif_unlock_cond(ssif_info, flags);
812 if ((result < 0) || (len < 3) || (msg->rsp[2] != 0)) {
813 /* Error getting event, probably done. */
816 /* Take off the event flag. */
817 ssif_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
818 handle_flags(ssif_info, flags);
819 } else if (msg->rsp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
820 || msg->rsp[1] != IPMI_READ_EVENT_MSG_BUFFER_CMD) {
821 pr_warn(PFX "Invalid response getting events: %x %x\n",
822 msg->rsp[0], msg->rsp[1]);
824 /* Take off the event flag. */
825 ssif_info->msg_flags &= ~EVENT_MSG_BUFFER_FULL;
826 handle_flags(ssif_info, flags);
828 handle_flags(ssif_info, flags);
829 ssif_inc_stat(ssif_info, events);
830 deliver_recv_msg(ssif_info, msg);
834 case SSIF_GETTING_MESSAGES:
836 /* Should never happen, but just in case. */
837 dev_warn(&ssif_info->client->dev,
838 "No message set while getting messages\n");
839 ipmi_ssif_unlock_cond(ssif_info, flags);
843 if ((result < 0) || (len < 3) || (msg->rsp[2] != 0)) {
844 /* Error getting event, probably done. */
847 /* Take off the msg flag. */
848 ssif_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
849 handle_flags(ssif_info, flags);
850 } else if (msg->rsp[0] != (IPMI_NETFN_APP_REQUEST | 1) << 2
851 || msg->rsp[1] != IPMI_GET_MSG_CMD) {
852 pr_warn(PFX "Invalid response clearing flags: %x %x\n",
853 msg->rsp[0], msg->rsp[1]);
856 /* Take off the msg flag. */
857 ssif_info->msg_flags &= ~RECEIVE_MSG_AVAIL;
858 handle_flags(ssif_info, flags);
860 ssif_inc_stat(ssif_info, incoming_messages);
861 handle_flags(ssif_info, flags);
862 deliver_recv_msg(ssif_info, msg);
867 /* Should never happen, but just in case. */
868 dev_warn(&ssif_info->client->dev,
869 "Invalid state in message done handling: %d\n",
870 ssif_info->ssif_state);
871 ipmi_ssif_unlock_cond(ssif_info, flags);
874 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
875 if (SSIF_IDLE(ssif_info) && !ssif_info->stopping) {
876 if (ssif_info->req_events)
877 start_event_fetch(ssif_info, flags);
878 else if (ssif_info->req_flags)
879 start_flag_fetch(ssif_info, flags);
881 start_next_msg(ssif_info, flags);
883 ipmi_ssif_unlock_cond(ssif_info, flags);
885 if (ssif_info->ssif_debug & SSIF_DEBUG_STATE)
886 pr_info(PFX "DONE 2: state = %d.\n", ssif_info->ssif_state);
889 static void msg_written_handler(struct ssif_info *ssif_info, int result,
890 unsigned char *data, unsigned int len)
894 /* We are single-threaded here, so no need for a lock. */
896 ssif_info->retries_left--;
897 if (ssif_info->retries_left > 0) {
898 if (!start_resend(ssif_info)) {
899 ssif_inc_stat(ssif_info, send_retries);
902 /* request failed, just return the error. */
903 ssif_inc_stat(ssif_info, send_errors);
905 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
907 "Out of retries in msg_written_handler\n");
908 msg_done_handler(ssif_info, -EIO, NULL, 0);
912 ssif_inc_stat(ssif_info, send_errors);
915 * Got an error on transmit, let the done routine
918 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
919 pr_info("Error in msg_written_handler: %d\n", result);
921 msg_done_handler(ssif_info, result, NULL, 0);
925 if (ssif_info->multi_data) {
927 * In the middle of a multi-data write. See the comment
928 * in the SSIF_MULTI_n_PART case in the probe function
929 * for details on the intricacies of this.
932 unsigned char *data_to_send;
934 ssif_inc_stat(ssif_info, sent_messages_parts);
936 left = ssif_info->multi_len - ssif_info->multi_pos;
940 ssif_info->multi_data[ssif_info->multi_pos] = left;
941 data_to_send = ssif_info->multi_data + ssif_info->multi_pos;
942 ssif_info->multi_pos += left;
945 * Write is finished. Note that we must end
946 * with a write of less than 32 bytes to
947 * complete the transaction, even if it is
950 ssif_info->multi_data = NULL;
952 rv = ssif_i2c_send(ssif_info, msg_written_handler,
954 SSIF_IPMI_MULTI_PART_REQUEST_MIDDLE,
956 I2C_SMBUS_BLOCK_DATA);
958 /* request failed, just return the error. */
959 ssif_inc_stat(ssif_info, send_errors);
961 if (ssif_info->ssif_debug & SSIF_DEBUG_MSG)
962 pr_info("Error from i2c_non_blocking_op(3)\n");
963 msg_done_handler(ssif_info, -EIO, NULL, 0);
966 /* Ready to request the result. */
967 unsigned long oflags, *flags;
969 ssif_inc_stat(ssif_info, sent_messages);
970 ssif_inc_stat(ssif_info, sent_messages_parts);
972 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
973 if (ssif_info->got_alert) {
974 /* The result is already ready, just start it. */
975 ssif_info->got_alert = false;
976 ipmi_ssif_unlock_cond(ssif_info, flags);
977 start_get(ssif_info);
979 /* Wait a jiffie then request the next message */
980 ssif_info->waiting_alert = true;
981 ssif_info->retries_left = SSIF_RECV_RETRIES;
982 ssif_info->rtc_us_timer = SSIF_MSG_PART_USEC;
983 if (!ssif_info->stopping)
984 mod_timer(&ssif_info->retry_timer,
985 jiffies + SSIF_MSG_PART_JIFFIES);
986 ipmi_ssif_unlock_cond(ssif_info, flags);
991 static int start_resend(struct ssif_info *ssif_info)
996 ssif_info->got_alert = false;
998 if (ssif_info->data_len > 32) {
999 command = SSIF_IPMI_MULTI_PART_REQUEST_START;
1000 ssif_info->multi_data = ssif_info->data;
1001 ssif_info->multi_len = ssif_info->data_len;
1003 * Subtle thing, this is 32, not 33, because we will
1004 * overwrite the thing at position 32 (which was just
1005 * transmitted) with the new length.
1007 ssif_info->multi_pos = 32;
1008 ssif_info->data[0] = 32;
1010 ssif_info->multi_data = NULL;
1011 command = SSIF_IPMI_REQUEST;
1012 ssif_info->data[0] = ssif_info->data_len;
1015 rv = ssif_i2c_send(ssif_info, msg_written_handler, I2C_SMBUS_WRITE,
1016 command, ssif_info->data, I2C_SMBUS_BLOCK_DATA);
1017 if (rv && (ssif_info->ssif_debug & SSIF_DEBUG_MSG))
1018 pr_info("Error from i2c_non_blocking_op(4)\n");
1022 static int start_send(struct ssif_info *ssif_info,
1023 unsigned char *data,
1026 if (len > IPMI_MAX_MSG_LENGTH)
1028 if (len > ssif_info->max_xmit_msg_size)
1031 ssif_info->retries_left = SSIF_SEND_RETRIES;
1032 memcpy(ssif_info->data + 1, data, len);
1033 ssif_info->data_len = len;
1034 return start_resend(ssif_info);
1037 /* Must be called with the message lock held. */
1038 static void start_next_msg(struct ssif_info *ssif_info, unsigned long *flags)
1040 struct ipmi_smi_msg *msg;
1041 unsigned long oflags;
1044 if (!SSIF_IDLE(ssif_info)) {
1045 ipmi_ssif_unlock_cond(ssif_info, flags);
1049 if (!ssif_info->waiting_msg) {
1050 ssif_info->curr_msg = NULL;
1051 ipmi_ssif_unlock_cond(ssif_info, flags);
1055 ssif_info->curr_msg = ssif_info->waiting_msg;
1056 ssif_info->waiting_msg = NULL;
1057 ipmi_ssif_unlock_cond(ssif_info, flags);
1058 rv = start_send(ssif_info,
1059 ssif_info->curr_msg->data,
1060 ssif_info->curr_msg->data_size);
1062 msg = ssif_info->curr_msg;
1063 ssif_info->curr_msg = NULL;
1064 return_hosed_msg(ssif_info, msg);
1065 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1071 static void sender(void *send_info,
1072 struct ipmi_smi_msg *msg)
1074 struct ssif_info *ssif_info = (struct ssif_info *) send_info;
1075 unsigned long oflags, *flags;
1077 BUG_ON(ssif_info->waiting_msg);
1078 ssif_info->waiting_msg = msg;
1080 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1081 start_next_msg(ssif_info, flags);
1083 if (ssif_info->ssif_debug & SSIF_DEBUG_TIMING) {
1084 struct timespec64 t;
1086 ktime_get_real_ts64(&t);
1087 pr_info("**Enqueue %02x %02x: %lld.%6.6ld\n",
1088 msg->data[0], msg->data[1],
1089 (long long) t.tv_sec, (long) t.tv_nsec / NSEC_PER_USEC);
1093 static int get_smi_info(void *send_info, struct ipmi_smi_info *data)
1095 struct ssif_info *ssif_info = send_info;
1097 data->addr_src = ssif_info->addr_source;
1098 data->dev = &ssif_info->client->dev;
1099 data->addr_info = ssif_info->addr_info;
1100 get_device(data->dev);
1106 * Instead of having our own timer to periodically check the message
1107 * flags, we let the message handler drive us.
1109 static void request_events(void *send_info)
1111 struct ssif_info *ssif_info = (struct ssif_info *) send_info;
1112 unsigned long oflags, *flags;
1114 if (!ssif_info->has_event_buffer)
1117 flags = ipmi_ssif_lock_cond(ssif_info, &oflags);
1119 * Request flags first, not events, because the lower layer
1120 * doesn't have a way to send an attention. But make sure
1121 * event checking still happens.
1123 ssif_info->req_events = true;
1124 if (SSIF_IDLE(ssif_info))
1125 start_flag_fetch(ssif_info, flags);
1127 ssif_info->req_flags = true;
1128 ipmi_ssif_unlock_cond(ssif_info, flags);
1132 static int ssif_start_processing(void *send_info,
1133 struct ipmi_smi *intf)
1135 struct ssif_info *ssif_info = send_info;
1137 ssif_info->intf = intf;
1142 #define MAX_SSIF_BMCS 4
1144 static unsigned short addr[MAX_SSIF_BMCS];
1145 static int num_addrs;
1146 module_param_array(addr, ushort, &num_addrs, 0);
1147 MODULE_PARM_DESC(addr, "The addresses to scan for IPMI BMCs on the SSIFs.");
1149 static char *adapter_name[MAX_SSIF_BMCS];
1150 static int num_adapter_names;
1151 module_param_array(adapter_name, charp, &num_adapter_names, 0);
1152 MODULE_PARM_DESC(adapter_name, "The string name of the I2C device that has the BMC. By default all devices are scanned.");
1154 static int slave_addrs[MAX_SSIF_BMCS];
1155 static int num_slave_addrs;
1156 module_param_array(slave_addrs, int, &num_slave_addrs, 0);
1157 MODULE_PARM_DESC(slave_addrs,
1158 "The default IPMB slave address for the controller.");
1160 static bool alerts_broken;
1161 module_param(alerts_broken, bool, 0);
1162 MODULE_PARM_DESC(alerts_broken, "Don't enable alerts for the controller.");
1165 * Bit 0 enables message debugging, bit 1 enables state debugging, and
1166 * bit 2 enables timing debugging. This is an array indexed by
1169 static int dbg[MAX_SSIF_BMCS];
1171 module_param_array(dbg, int, &num_dbg, 0);
1172 MODULE_PARM_DESC(dbg, "Turn on debugging.");
1174 static bool ssif_dbg_probe;
1175 module_param_named(dbg_probe, ssif_dbg_probe, bool, 0);
1176 MODULE_PARM_DESC(dbg_probe, "Enable debugging of probing of adapters.");
1178 static bool ssif_tryacpi = true;
1179 module_param_named(tryacpi, ssif_tryacpi, bool, 0);
1180 MODULE_PARM_DESC(tryacpi, "Setting this to zero will disable the default scan of the interfaces identified via ACPI");
1182 static bool ssif_trydmi = true;
1183 module_param_named(trydmi, ssif_trydmi, bool, 0);
1184 MODULE_PARM_DESC(trydmi, "Setting this to zero will disable the default scan of the interfaces identified via DMI (SMBIOS)");
1186 static DEFINE_MUTEX(ssif_infos_mutex);
1187 static LIST_HEAD(ssif_infos);
1189 #define IPMI_SSIF_ATTR(name) \
1190 static ssize_t ipmi_##name##_show(struct device *dev, \
1191 struct device_attribute *attr, \
1194 struct ssif_info *ssif_info = dev_get_drvdata(dev); \
1196 return snprintf(buf, 10, "%u\n", ssif_get_stat(ssif_info, name));\
1198 static DEVICE_ATTR(name, S_IRUGO, ipmi_##name##_show, NULL)
1200 static ssize_t ipmi_type_show(struct device *dev,
1201 struct device_attribute *attr,
1204 return snprintf(buf, 10, "ssif\n");
1206 static DEVICE_ATTR(type, S_IRUGO, ipmi_type_show, NULL);
1208 IPMI_SSIF_ATTR(sent_messages);
1209 IPMI_SSIF_ATTR(sent_messages_parts);
1210 IPMI_SSIF_ATTR(send_retries);
1211 IPMI_SSIF_ATTR(send_errors);
1212 IPMI_SSIF_ATTR(received_messages);
1213 IPMI_SSIF_ATTR(received_message_parts);
1214 IPMI_SSIF_ATTR(receive_retries);
1215 IPMI_SSIF_ATTR(receive_errors);
1216 IPMI_SSIF_ATTR(flag_fetches);
1217 IPMI_SSIF_ATTR(hosed);
1218 IPMI_SSIF_ATTR(events);
1219 IPMI_SSIF_ATTR(watchdog_pretimeouts);
1220 IPMI_SSIF_ATTR(alerts);
1222 static struct attribute *ipmi_ssif_dev_attrs[] = {
1223 &dev_attr_type.attr,
1224 &dev_attr_sent_messages.attr,
1225 &dev_attr_sent_messages_parts.attr,
1226 &dev_attr_send_retries.attr,
1227 &dev_attr_send_errors.attr,
1228 &dev_attr_received_messages.attr,
1229 &dev_attr_received_message_parts.attr,
1230 &dev_attr_receive_retries.attr,
1231 &dev_attr_receive_errors.attr,
1232 &dev_attr_flag_fetches.attr,
1233 &dev_attr_hosed.attr,
1234 &dev_attr_events.attr,
1235 &dev_attr_watchdog_pretimeouts.attr,
1236 &dev_attr_alerts.attr,
1240 static const struct attribute_group ipmi_ssif_dev_attr_group = {
1241 .attrs = ipmi_ssif_dev_attrs,
1244 static void shutdown_ssif(void *send_info)
1246 struct ssif_info *ssif_info = send_info;
1248 device_remove_group(&ssif_info->client->dev, &ipmi_ssif_dev_attr_group);
1249 dev_set_drvdata(&ssif_info->client->dev, NULL);
1251 /* make sure the driver is not looking for flags any more. */
1252 while (ssif_info->ssif_state != SSIF_NORMAL)
1253 schedule_timeout(1);
1255 ssif_info->stopping = true;
1256 del_timer_sync(&ssif_info->retry_timer);
1257 if (ssif_info->thread) {
1258 complete(&ssif_info->wake_thread);
1259 kthread_stop(ssif_info->thread);
1263 static int ssif_remove(struct i2c_client *client)
1265 struct ssif_info *ssif_info = i2c_get_clientdata(client);
1266 struct ssif_addr_info *addr_info;
1272 * After this point, we won't deliver anything asychronously
1273 * to the message handler. We can unregister ourself.
1275 ipmi_unregister_smi(ssif_info->intf);
1277 list_for_each_entry(addr_info, &ssif_infos, link) {
1278 if (addr_info->client == client) {
1279 addr_info->client = NULL;
1289 static int do_cmd(struct i2c_client *client, int len, unsigned char *msg,
1290 int *resp_len, unsigned char *resp)
1295 retry_cnt = SSIF_SEND_RETRIES;
1297 ret = i2c_smbus_write_block_data(client, SSIF_IPMI_REQUEST, len, msg);
1306 retry_cnt = SSIF_RECV_RETRIES;
1307 while (retry_cnt > 0) {
1308 ret = i2c_smbus_read_block_data(client, SSIF_IPMI_RESPONSE,
1312 msleep(SSIF_MSG_MSEC);
1319 /* Validate that the response is correct. */
1321 (resp[0] != (msg[0] | (1 << 2))) ||
1322 (resp[1] != msg[1]))
1333 static int ssif_detect(struct i2c_client *client, struct i2c_board_info *info)
1335 unsigned char *resp;
1336 unsigned char msg[3];
1340 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1344 /* Do a Get Device ID command, since it is required. */
1345 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1346 msg[1] = IPMI_GET_DEVICE_ID_CMD;
1347 rv = do_cmd(client, 2, msg, &len, resp);
1351 strlcpy(info->type, DEVICE_NAME, I2C_NAME_SIZE);
1356 static int strcmp_nospace(char *s1, char *s2)
1358 while (*s1 && *s2) {
1359 while (isspace(*s1))
1361 while (isspace(*s2))
1373 static struct ssif_addr_info *ssif_info_find(unsigned short addr,
1375 bool match_null_name)
1377 struct ssif_addr_info *info, *found = NULL;
1380 list_for_each_entry(info, &ssif_infos, link) {
1381 if (info->binfo.addr == addr) {
1382 if (info->adapter_name || adapter_name) {
1383 if (!info->adapter_name != !adapter_name) {
1384 /* One is NULL and one is not */
1388 strcmp_nospace(info->adapter_name,
1390 /* Names do not match */
1398 if (!found && match_null_name) {
1399 /* Try to get an exact match first, then try with a NULL name */
1400 adapter_name = NULL;
1401 match_null_name = false;
1408 static bool check_acpi(struct ssif_info *ssif_info, struct device *dev)
1411 acpi_handle acpi_handle;
1413 acpi_handle = ACPI_HANDLE(dev);
1415 ssif_info->addr_source = SI_ACPI;
1416 ssif_info->addr_info.acpi_info.acpi_handle = acpi_handle;
1423 static int find_slave_address(struct i2c_client *client, int slave_addr)
1425 #ifdef CONFIG_IPMI_DMI_DECODE
1427 slave_addr = ipmi_dmi_get_slave_addr(
1429 i2c_adapter_id(client->adapter),
1437 * Global enables we care about.
1439 #define GLOBAL_ENABLES_MASK (IPMI_BMC_EVT_MSG_BUFF | IPMI_BMC_RCV_MSG_INTR | \
1440 IPMI_BMC_EVT_MSG_INTR)
1442 static int ssif_probe(struct i2c_client *client, const struct i2c_device_id *id)
1444 unsigned char msg[3];
1445 unsigned char *resp;
1446 struct ssif_info *ssif_info;
1451 struct ssif_addr_info *addr_info = NULL;
1453 resp = kmalloc(IPMI_MAX_MSG_LENGTH, GFP_KERNEL);
1457 ssif_info = kzalloc(sizeof(*ssif_info), GFP_KERNEL);
1463 if (!check_acpi(ssif_info, &client->dev)) {
1464 addr_info = ssif_info_find(client->addr, client->adapter->name,
1467 /* Must have come in through sysfs. */
1468 ssif_info->addr_source = SI_HOTMOD;
1470 ssif_info->addr_source = addr_info->addr_src;
1471 ssif_info->ssif_debug = addr_info->debug;
1472 ssif_info->addr_info = addr_info->addr_info;
1473 addr_info->client = client;
1474 slave_addr = addr_info->slave_addr;
1478 slave_addr = find_slave_address(client, slave_addr);
1480 pr_info(PFX "Trying %s-specified SSIF interface at i2c address 0x%x, adapter %s, slave address 0x%x\n",
1481 ipmi_addr_src_to_str(ssif_info->addr_source),
1482 client->addr, client->adapter->name, slave_addr);
1484 ssif_info->client = client;
1485 i2c_set_clientdata(client, ssif_info);
1487 /* Now check for system interface capabilities */
1488 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1489 msg[1] = IPMI_GET_SYSTEM_INTERFACE_CAPABILITIES_CMD;
1490 msg[2] = 0; /* SSIF */
1491 rv = do_cmd(client, 3, msg, &len, resp);
1492 if (!rv && (len >= 3) && (resp[2] == 0)) {
1495 pr_info(PFX "SSIF info too short: %d\n", len);
1499 /* Got a good SSIF response, handle it. */
1500 ssif_info->max_xmit_msg_size = resp[5];
1501 ssif_info->max_recv_msg_size = resp[6];
1502 ssif_info->multi_support = (resp[4] >> 6) & 0x3;
1503 ssif_info->supports_pec = (resp[4] >> 3) & 0x1;
1505 /* Sanitize the data */
1506 switch (ssif_info->multi_support) {
1508 if (ssif_info->max_xmit_msg_size > 32)
1509 ssif_info->max_xmit_msg_size = 32;
1510 if (ssif_info->max_recv_msg_size > 32)
1511 ssif_info->max_recv_msg_size = 32;
1514 case SSIF_MULTI_2_PART:
1515 if (ssif_info->max_xmit_msg_size > 63)
1516 ssif_info->max_xmit_msg_size = 63;
1517 if (ssif_info->max_recv_msg_size > 62)
1518 ssif_info->max_recv_msg_size = 62;
1521 case SSIF_MULTI_n_PART:
1523 * The specification is rather confusing at
1524 * this point, but I think I understand what
1525 * is meant. At least I have a workable
1526 * solution. With multi-part messages, you
1527 * cannot send a message that is a multiple of
1528 * 32-bytes in length, because the start and
1529 * middle messages are 32-bytes and the end
1530 * message must be at least one byte. You
1531 * can't fudge on an extra byte, that would
1532 * screw up things like fru data writes. So
1533 * we limit the length to 63 bytes. That way
1534 * a 32-byte message gets sent as a single
1535 * part. A larger message will be a 32-byte
1536 * start and the next message is always going
1537 * to be 1-31 bytes in length. Not ideal, but
1540 if (ssif_info->max_xmit_msg_size > 63)
1541 ssif_info->max_xmit_msg_size = 63;
1545 /* Data is not sane, just give up. */
1550 /* Assume no multi-part or PEC support */
1551 pr_info(PFX "Error fetching SSIF: %d %d %2.2x, your system probably doesn't support this command so using defaults\n",
1554 ssif_info->max_xmit_msg_size = 32;
1555 ssif_info->max_recv_msg_size = 32;
1556 ssif_info->multi_support = SSIF_NO_MULTI;
1557 ssif_info->supports_pec = 0;
1560 /* Make sure the NMI timeout is cleared. */
1561 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1562 msg[1] = IPMI_CLEAR_MSG_FLAGS_CMD;
1563 msg[2] = WDT_PRE_TIMEOUT_INT;
1564 rv = do_cmd(client, 3, msg, &len, resp);
1565 if (rv || (len < 3) || (resp[2] != 0))
1566 pr_warn(PFX "Unable to clear message flags: %d %d %2.2x\n",
1569 /* Attempt to enable the event buffer. */
1570 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1571 msg[1] = IPMI_GET_BMC_GLOBAL_ENABLES_CMD;
1572 rv = do_cmd(client, 2, msg, &len, resp);
1573 if (rv || (len < 4) || (resp[2] != 0)) {
1574 pr_warn(PFX "Error getting global enables: %d %d %2.2x\n",
1576 rv = 0; /* Not fatal */
1580 ssif_info->global_enables = resp[3];
1582 if (resp[3] & IPMI_BMC_EVT_MSG_BUFF) {
1583 ssif_info->has_event_buffer = true;
1584 /* buffer is already enabled, nothing to do. */
1588 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1589 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
1590 msg[2] = ssif_info->global_enables | IPMI_BMC_EVT_MSG_BUFF;
1591 rv = do_cmd(client, 3, msg, &len, resp);
1592 if (rv || (len < 2)) {
1593 pr_warn(PFX "Error setting global enables: %d %d %2.2x\n",
1595 rv = 0; /* Not fatal */
1600 /* A successful return means the event buffer is supported. */
1601 ssif_info->has_event_buffer = true;
1602 ssif_info->global_enables |= IPMI_BMC_EVT_MSG_BUFF;
1605 /* Some systems don't behave well if you enable alerts. */
1609 msg[0] = IPMI_NETFN_APP_REQUEST << 2;
1610 msg[1] = IPMI_SET_BMC_GLOBAL_ENABLES_CMD;
1611 msg[2] = ssif_info->global_enables | IPMI_BMC_RCV_MSG_INTR;
1612 rv = do_cmd(client, 3, msg, &len, resp);
1613 if (rv || (len < 2)) {
1614 pr_warn(PFX "Error setting global enables: %d %d %2.2x\n",
1616 rv = 0; /* Not fatal */
1621 /* A successful return means the alert is supported. */
1622 ssif_info->supports_alert = true;
1623 ssif_info->global_enables |= IPMI_BMC_RCV_MSG_INTR;
1627 if (ssif_dbg_probe) {
1628 pr_info("ssif_probe: i2c_probe found device at i2c address %x\n",
1632 spin_lock_init(&ssif_info->lock);
1633 ssif_info->ssif_state = SSIF_NORMAL;
1634 timer_setup(&ssif_info->retry_timer, retry_timeout, 0);
1636 for (i = 0; i < SSIF_NUM_STATS; i++)
1637 atomic_set(&ssif_info->stats[i], 0);
1639 if (ssif_info->supports_pec)
1640 ssif_info->client->flags |= I2C_CLIENT_PEC;
1642 ssif_info->handlers.owner = THIS_MODULE;
1643 ssif_info->handlers.start_processing = ssif_start_processing;
1644 ssif_info->handlers.shutdown = shutdown_ssif;
1645 ssif_info->handlers.get_smi_info = get_smi_info;
1646 ssif_info->handlers.sender = sender;
1647 ssif_info->handlers.request_events = request_events;
1650 unsigned int thread_num;
1652 thread_num = ((i2c_adapter_id(ssif_info->client->adapter)
1654 ssif_info->client->addr);
1655 init_completion(&ssif_info->wake_thread);
1656 ssif_info->thread = kthread_run(ipmi_ssif_thread, ssif_info,
1657 "kssif%4.4x", thread_num);
1658 if (IS_ERR(ssif_info->thread)) {
1659 rv = PTR_ERR(ssif_info->thread);
1660 dev_notice(&ssif_info->client->dev,
1661 "Could not start kernel thread: error %d\n",
1667 dev_set_drvdata(&ssif_info->client->dev, ssif_info);
1668 rv = device_add_group(&ssif_info->client->dev,
1669 &ipmi_ssif_dev_attr_group);
1671 dev_err(&ssif_info->client->dev,
1672 "Unable to add device attributes: error %d\n",
1677 rv = ipmi_register_smi(&ssif_info->handlers,
1679 &ssif_info->client->dev,
1682 pr_err(PFX "Unable to register device: error %d\n", rv);
1683 goto out_remove_attr;
1689 addr_info->client = NULL;
1691 dev_err(&client->dev, "Unable to start IPMI SSIF: %d\n", rv);
1698 device_remove_group(&ssif_info->client->dev, &ipmi_ssif_dev_attr_group);
1699 dev_set_drvdata(&ssif_info->client->dev, NULL);
1703 static int ssif_adapter_handler(struct device *adev, void *opaque)
1705 struct ssif_addr_info *addr_info = opaque;
1707 if (adev->type != &i2c_adapter_type)
1710 addr_info->added_client = i2c_new_device(to_i2c_adapter(adev),
1713 if (!addr_info->adapter_name)
1714 return 1; /* Only try the first I2C adapter by default. */
1718 static int new_ssif_client(int addr, char *adapter_name,
1719 int debug, int slave_addr,
1720 enum ipmi_addr_src addr_src,
1723 struct ssif_addr_info *addr_info;
1726 mutex_lock(&ssif_infos_mutex);
1727 if (ssif_info_find(addr, adapter_name, false)) {
1732 addr_info = kzalloc(sizeof(*addr_info), GFP_KERNEL);
1739 addr_info->adapter_name = kstrdup(adapter_name, GFP_KERNEL);
1740 if (!addr_info->adapter_name) {
1747 strncpy(addr_info->binfo.type, DEVICE_NAME,
1748 sizeof(addr_info->binfo.type));
1749 addr_info->binfo.addr = addr;
1750 addr_info->binfo.platform_data = addr_info;
1751 addr_info->debug = debug;
1752 addr_info->slave_addr = slave_addr;
1753 addr_info->addr_src = addr_src;
1754 addr_info->dev = dev;
1757 dev_set_drvdata(dev, addr_info);
1759 list_add_tail(&addr_info->link, &ssif_infos);
1762 i2c_for_each_dev(addr_info, ssif_adapter_handler);
1763 /* Otherwise address list will get it */
1766 mutex_unlock(&ssif_infos_mutex);
1770 static void free_ssif_clients(void)
1772 struct ssif_addr_info *info, *tmp;
1774 mutex_lock(&ssif_infos_mutex);
1775 list_for_each_entry_safe(info, tmp, &ssif_infos, link) {
1776 list_del(&info->link);
1777 kfree(info->adapter_name);
1780 mutex_unlock(&ssif_infos_mutex);
1783 static unsigned short *ssif_address_list(void)
1785 struct ssif_addr_info *info;
1786 unsigned int count = 0, i;
1787 unsigned short *address_list;
1789 list_for_each_entry(info, &ssif_infos, link)
1792 address_list = kcalloc(count + 1, sizeof(*address_list),
1798 list_for_each_entry(info, &ssif_infos, link) {
1799 unsigned short addr = info->binfo.addr;
1802 for (j = 0; j < i; j++) {
1803 if (address_list[j] == addr)
1806 address_list[i] = addr;
1810 address_list[i] = I2C_CLIENT_END;
1812 return address_list;
1816 static const struct acpi_device_id ssif_acpi_match[] = {
1820 MODULE_DEVICE_TABLE(acpi, ssif_acpi_match);
1824 static int dmi_ipmi_probe(struct platform_device *pdev)
1833 rv = device_property_read_u16(&pdev->dev, "i2c-addr", &i2c_addr);
1835 dev_warn(&pdev->dev, PFX "No i2c-addr property\n");
1839 rv = device_property_read_u8(&pdev->dev, "slave-addr", &slave_addr);
1841 dev_warn(&pdev->dev, "device has no slave-addr property");
1843 return new_ssif_client(i2c_addr, NULL, 0,
1844 slave_addr, SI_SMBIOS, &pdev->dev);
1847 static int dmi_ipmi_probe(struct platform_device *pdev)
1853 static const struct i2c_device_id ssif_id[] = {
1857 MODULE_DEVICE_TABLE(i2c, ssif_id);
1859 static struct i2c_driver ssif_i2c_driver = {
1860 .class = I2C_CLASS_HWMON,
1864 .probe = ssif_probe,
1865 .remove = ssif_remove,
1866 .alert = ssif_alert,
1867 .id_table = ssif_id,
1868 .detect = ssif_detect
1871 static int ssif_platform_probe(struct platform_device *dev)
1873 return dmi_ipmi_probe(dev);
1876 static int ssif_platform_remove(struct platform_device *dev)
1878 struct ssif_addr_info *addr_info = dev_get_drvdata(&dev->dev);
1883 mutex_lock(&ssif_infos_mutex);
1884 i2c_unregister_device(addr_info->added_client);
1886 list_del(&addr_info->link);
1888 mutex_unlock(&ssif_infos_mutex);
1892 static struct platform_driver ipmi_driver = {
1894 .name = DEVICE_NAME,
1896 .probe = ssif_platform_probe,
1897 .remove = ssif_platform_remove,
1900 static int init_ipmi_ssif(void)
1908 pr_info("IPMI SSIF Interface driver\n");
1910 /* build list for i2c from addr list */
1911 for (i = 0; i < num_addrs; i++) {
1912 rv = new_ssif_client(addr[i], adapter_name[i],
1913 dbg[i], slave_addrs[i],
1914 SI_HARDCODED, NULL);
1917 "Couldn't add hardcoded device at addr 0x%x\n",
1922 ssif_i2c_driver.driver.acpi_match_table =
1923 ACPI_PTR(ssif_acpi_match);
1926 rv = platform_driver_register(&ipmi_driver);
1928 pr_err(PFX "Unable to register driver: %d\n", rv);
1931 ssif_i2c_driver.address_list = ssif_address_list();
1933 rv = i2c_add_driver(&ssif_i2c_driver);
1939 module_init(init_ipmi_ssif);
1941 static void cleanup_ipmi_ssif(void)
1946 initialized = false;
1948 i2c_del_driver(&ssif_i2c_driver);
1950 platform_driver_unregister(&ipmi_driver);
1952 free_ssif_clients();
1954 module_exit(cleanup_ipmi_ssif);
1956 MODULE_ALIAS("platform:dmi-ipmi-ssif");
1957 MODULE_AUTHOR("Todd C Davis <todd.c.davis@intel.com>, Corey Minyard <minyard@acm.org>");
1958 MODULE_DESCRIPTION("IPMI driver for management controllers on a SMBus");
1959 MODULE_LICENSE("GPL");