Quelle  ipmi_msghandler.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0+
/*
 * ipmi_msghandler.c
 *
 * Incoming and outgoing message routing for an IPMI interface.
 *
 * Author: MontaVista Software, Inc.
 *         Corey Minyard <minyard@mvista.com>
 *         source@mvista.com
 *
 * Copyright 2002 MontaVista Software Inc.
 */

#define pr_fmt(fmt) "IPMI message handler: " fmt
#define dev_fmt(fmt) pr_fmt(fmt)

#include <linux/module.h>
#include <linux/errno.h>
#include <linux/panic_notifier.h>
#include <linux/poll.h>
#include <linux/sched.h>
#include <linux/seq_file.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <linux/ipmi.h>
#include <linux/ipmi_smi.h>
#include <linux/notifier.h>
#include <linux/init.h>
#include <linux/rcupdate.h>
#include <linux/interrupt.h>
#include <linux/moduleparam.h>
#include <linux/workqueue.h>
#include <linux/uuid.h>
#include <linux/nospec.h>
#include <linux/vmalloc.h>
#include <linux/delay.h>

#define IPMI_DRIVER_VERSION "39.2"

static struct ipmi_recv_msg *ipmi_alloc_recv_msg(struct ipmi_user *user);
static void ipmi_set_recv_msg_user(struct ipmi_recv_msg *msg,
       struct ipmi_user *user);
static int ipmi_init_msghandler(void);
static void smi_work(struct work_struct *t);
static void handle_new_recv_msgs(struct ipmi_smi *intf);
static void need_waiter(struct ipmi_smi *intf);
static int handle_one_recv_msg(struct ipmi_smi *intf,
          struct ipmi_smi_msg *msg);
static void intf_free(struct kref *ref);

static bool initialized;
static bool drvregistered;

/* Numbers in this enumerator should be mapped to ipmi_panic_event_str */
enum ipmi_panic_event_op {
 IPMI_SEND_PANIC_EVENT_NONE,
 IPMI_SEND_PANIC_EVENT,
 IPMI_SEND_PANIC_EVENT_STRING,
 IPMI_SEND_PANIC_EVENT_MAX
};

/* Indices in this array should be mapped to enum ipmi_panic_event_op */
static const char *const ipmi_panic_event_str[] = { "none", "event", "string", NULL };

#ifdef CONFIG_IPMI_PANIC_STRING
#define IPMI_PANIC_DEFAULT IPMI_SEND_PANIC_EVENT_STRING
#elif defined(CONFIG_IPMI_PANIC_EVENT)
#define IPMI_PANIC_DEFAULT IPMI_SEND_PANIC_EVENT
#else
#define IPMI_PANIC_DEFAULT IPMI_SEND_PANIC_EVENT_NONE
#endif

static enum ipmi_panic_event_op ipmi_send_panic_event = IPMI_PANIC_DEFAULT;

static int panic_op_write_handler(const char *val,
      const struct kernel_param *kp)
{
 char valcp[16];
 int e;

 strscpy(valcp, val, sizeof(valcp));
 e = match_string(ipmi_panic_event_str, -1, strstrip(valcp));
 if (e < 0)
  return e;

 ipmi_send_panic_event = e;
 return 0;
}

static int panic_op_read_handler(char *buffer, const struct kernel_param *kp)
{
 const char *event_str;

 if (ipmi_send_panic_event >= IPMI_SEND_PANIC_EVENT_MAX)
  event_str = "???";
 else
  event_str = ipmi_panic_event_str[ipmi_send_panic_event];

 return sprintf(buffer, "%s\n", event_str);
}

static const struct kernel_param_ops panic_op_ops = {
 .set = panic_op_write_handler,
 .get = panic_op_read_handler
};
module_param_cb(panic_op, &panic_op_ops, NULL, 0600);
MODULE_PARM_DESC(panic_op, "Sets if the IPMI driver will attempt to store panic information in the event log in the event of a panic. Set to 'none' for no, 'event' for a single event, or 'string' for a generic event and the panic string in IPMI OEM events.");


#define MAX_EVENTS_IN_QUEUE 25

/* Remain in auto-maintenance mode for this amount of time (in ms). */
static unsigned long maintenance_mode_timeout_ms = 30000;
module_param(maintenance_mode_timeout_ms, ulong, 0644);
MODULE_PARM_DESC(maintenance_mode_timeout_ms,
   "The time (milliseconds) after the last maintenance message that the connection stays in maintenance mode.");

/*
 * Don't let a message sit in a queue forever, always time it with at lest
 * the max message timer.  This is in milliseconds.
 */
#define MAX_MSG_TIMEOUT  60000

/*
 * Timeout times below are in milliseconds, and are done off a 1
 * second timer.  So setting the value to 1000 would mean anything
 * between 0 and 1000ms.  So really the only reasonable minimum
 * setting it 2000ms, which is between 1 and 2 seconds.
 */

/* The default timeout for message retries. */
static unsigned long default_retry_ms = 2000;
module_param(default_retry_ms, ulong, 0644);
MODULE_PARM_DESC(default_retry_ms,
   "The time (milliseconds) between retry sends");

/* The default timeout for maintenance mode message retries. */
static unsigned long default_maintenance_retry_ms = 3000;
module_param(default_maintenance_retry_ms, ulong, 0644);
MODULE_PARM_DESC(default_maintenance_retry_ms,
   "The time (milliseconds) between retry sends in maintenance mode");

/* The default maximum number of retries */
static unsigned int default_max_retries = 4;
module_param(default_max_retries, uint, 0644);
MODULE_PARM_DESC(default_max_retries,
   "The time (milliseconds) between retry sends in maintenance mode");

/* The default maximum number of users that may register. */
static unsigned int max_users = 30;
module_param(max_users, uint, 0644);
MODULE_PARM_DESC(max_users,
   "The most users that may use the IPMI stack at one time.");

/* The default maximum number of message a user may have outstanding. */
static unsigned int max_msgs_per_user = 100;
module_param(max_msgs_per_user, uint, 0644);
MODULE_PARM_DESC(max_msgs_per_user,
   "The most message a user may have outstanding.");

/* Call every ~1000 ms. */
#define IPMI_TIMEOUT_TIME 1000

/* How many jiffies does it take to get to the timeout time. */
#define IPMI_TIMEOUT_JIFFIES ((IPMI_TIMEOUT_TIME * HZ) / 1000)

/*
 * Request events from the queue every second (this is the number of
 * IPMI_TIMEOUT_TIMES between event requests).  Hopefully, in the
 * future, IPMI will add a way to know immediately if an event is in
 * the queue and this silliness can go away.
 */
#define IPMI_REQUEST_EV_TIME (1000 / (IPMI_TIMEOUT_TIME))

/* How long should we cache dynamic device IDs? */
#define IPMI_DYN_DEV_ID_EXPIRY (10 * HZ)

/*
 * The main "user" data structure.
 */
struct ipmi_user {
 struct list_head link;

 struct kref refcount;
 refcount_t destroyed;

 /* The upper layer that handles receive messages. */
 const struct ipmi_user_hndl *handler;
 void             *handler_data;

 /* The interface this user is bound to. */
 struct ipmi_smi *intf;

 /* Does this interface receive IPMI events? */
 bool gets_events;

 atomic_t nr_msgs;
};

struct cmd_rcvr {
 struct list_head link;

 struct ipmi_user *user;
 unsigned char netfn;
 unsigned char cmd;
 unsigned int  chans;

 /*
 * This is used to form a linked lised during mass deletion.
 * Since this is in an RCU list, we cannot use the link above
 * or change any data until the RCU period completes.  So we
 * use this next variable during mass deletion so we can have
 * a list and don't have to wait and restart the search on
 * every individual deletion of a command.
 */
 struct cmd_rcvr *next;
};

struct seq_table {
 unsigned int         inuse : 1;
 unsigned int         broadcast : 1;

 unsigned long        timeout;
 unsigned long        orig_timeout;
 unsigned int         retries_left;

 /*
 * To verify on an incoming send message response that this is
 * the message that the response is for, we keep a sequence id
 * and increment it every time we send a message.
 */
 long                 seqid;

 /*
 * This is held so we can properly respond to the message on a
 * timeout, and it is used to hold the temporary data for
 * retransmission, too.
 */
 struct ipmi_recv_msg *recv_msg;
};

/*
 * Store the information in a msgid (long) to allow us to find a
 * sequence table entry from the msgid.
 */
#define STORE_SEQ_IN_MSGID(seq, seqid) \
 ((((seq) & 0x3f) << 26) | ((seqid) & 0x3ffffff))

#define GET_SEQ_FROM_MSGID(msgid, seq, seqid) \
 do {        \
  seq = (((msgid) >> 26) & 0x3f);    \
  seqid = ((msgid) & 0x3ffffff);    \
 } while (0)

#define NEXT_SEQID(seqid) (((seqid) + 1) & 0x3ffffff)

#define IPMI_MAX_CHANNELS       16
struct ipmi_channel {
 unsigned char medium;
 unsigned char protocol;
};

struct ipmi_channel_set {
 struct ipmi_channel c[IPMI_MAX_CHANNELS];
};

struct ipmi_my_addrinfo {
 /*
 * My slave address.  This is initialized to IPMI_BMC_SLAVE_ADDR,
 * but may be changed by the user.
 */
 unsigned char address;

 /*
 * My LUN.  This should generally stay the SMS LUN, but just in
 * case...
 */
 unsigned char lun;
};

/*
 * Note that the product id, manufacturer id, guid, and device id are
 * immutable in this structure, so dyn_mutex is not required for
 * accessing those.  If those change on a BMC, a new BMC is allocated.
 */
struct bmc_device {
 struct platform_device pdev;
 struct list_head       intfs; /* Interfaces on this BMC. */
 struct ipmi_device_id  id;
 struct ipmi_device_id  fetch_id;
 int                    dyn_id_set;
 unsigned long          dyn_id_expiry;
 struct mutex           dyn_mutex; /* Protects id, intfs, & dyn* */
 guid_t                 guid;
 guid_t                 fetch_guid;
 int                    dyn_guid_set;
 struct kref        usecount;
 struct work_struct     remove_work;
 unsigned char        cc; /* completion code */
};
#define to_bmc_device(x) container_of((x), struct bmc_device, pdev.dev)

static struct workqueue_struct *bmc_remove_work_wq;

static int bmc_get_device_id(struct ipmi_smi *intf, struct bmc_device *bmc,
        struct ipmi_device_id *id,
        bool *guid_set, guid_t *guid);

/*
 * Various statistics for IPMI, these index stats[] in the ipmi_smi
 * structure.
 */
enum ipmi_stat_indexes {
 /* Commands we got from the user that were invalid. */
 IPMI_STAT_sent_invalid_commands = 0,

 /* Commands we sent to the MC. */
 IPMI_STAT_sent_local_commands,

 /* Responses from the MC that were delivered to a user. */
 IPMI_STAT_handled_local_responses,

 /* Responses from the MC that were not delivered to a user. */
 IPMI_STAT_unhandled_local_responses,

 /* Commands we sent out to the IPMB bus. */
 IPMI_STAT_sent_ipmb_commands,

 /* Commands sent on the IPMB that had errors on the SEND CMD */
 IPMI_STAT_sent_ipmb_command_errs,

 /* Each retransmit increments this count. */
 IPMI_STAT_retransmitted_ipmb_commands,

 /*
 * When a message times out (runs out of retransmits) this is
 * incremented.
 */
 IPMI_STAT_timed_out_ipmb_commands,

 /*
 * This is like above, but for broadcasts.  Broadcasts are
 * *not* included in the above count (they are expected to
 * time out).
 */
 IPMI_STAT_timed_out_ipmb_broadcasts,

 /* Responses I have sent to the IPMB bus. */
 IPMI_STAT_sent_ipmb_responses,

 /* The response was delivered to the user. */
 IPMI_STAT_handled_ipmb_responses,

 /* The response had invalid data in it. */
 IPMI_STAT_invalid_ipmb_responses,

 /* The response didn't have anyone waiting for it. */
 IPMI_STAT_unhandled_ipmb_responses,

 /* Commands we sent out to the IPMB bus. */
 IPMI_STAT_sent_lan_commands,

 /* Commands sent on the IPMB that had errors on the SEND CMD */
 IPMI_STAT_sent_lan_command_errs,

 /* Each retransmit increments this count. */
 IPMI_STAT_retransmitted_lan_commands,

 /*
 * When a message times out (runs out of retransmits) this is
 * incremented.
 */
 IPMI_STAT_timed_out_lan_commands,

 /* Responses I have sent to the IPMB bus. */
 IPMI_STAT_sent_lan_responses,

 /* The response was delivered to the user. */
 IPMI_STAT_handled_lan_responses,

 /* The response had invalid data in it. */
 IPMI_STAT_invalid_lan_responses,

 /* The response didn't have anyone waiting for it. */
 IPMI_STAT_unhandled_lan_responses,

 /* The command was delivered to the user. */
 IPMI_STAT_handled_commands,

 /* The command had invalid data in it. */
 IPMI_STAT_invalid_commands,

 /* The command didn't have anyone waiting for it. */
 IPMI_STAT_unhandled_commands,

 /* Invalid data in an event. */
 IPMI_STAT_invalid_events,

 /* Events that were received with the proper format. */
 IPMI_STAT_events,

 /* Retransmissions on IPMB that failed. */
 IPMI_STAT_dropped_rexmit_ipmb_commands,

 /* Retransmissions on LAN that failed. */
 IPMI_STAT_dropped_rexmit_lan_commands,

 /* This *must* remain last, add new values above this. */
 IPMI_NUM_STATS
};


#define IPMI_IPMB_NUM_SEQ 64
struct ipmi_smi {
 struct module *owner;

 /* What interface number are we? */
 int intf_num;

 struct kref refcount;

 /* Set when the interface is being unregistered. */
 bool in_shutdown;

 /* Used for a list of interfaces. */
 struct list_head link;

 /*
 * The list of upper layers that are using me.
 */
 struct list_head users;
 struct mutex users_mutex;
 atomic_t nr_users;
 struct device_attribute nr_users_devattr;
 struct device_attribute nr_msgs_devattr;


 /* Used for wake ups at startup. */
 wait_queue_head_t waitq;

 /*
 * Prevents the interface from being unregistered when the
 * interface is used by being looked up through the BMC
 * structure.
 */
 struct mutex bmc_reg_mutex;

 struct bmc_device tmp_bmc;
 struct bmc_device *bmc;
 bool bmc_registered;
 struct list_head bmc_link;
 char *my_dev_name;
 bool in_bmc_register;  /* Handle recursive situations.  Yuck. */
 struct work_struct bmc_reg_work;

 const struct ipmi_smi_handlers *handlers;
 void                     *send_info;

 /* Driver-model device for the system interface. */
 struct device          *si_dev;

 /*
 * A table of sequence numbers for this interface.  We use the
 * sequence numbers for IPMB messages that go out of the
 * interface to match them up with their responses.  A routine
 * is called periodically to time the items in this list.
 */
 struct mutex seq_lock;
 struct seq_table seq_table[IPMI_IPMB_NUM_SEQ];
 int curr_seq;

 /*
 * Messages queued for deliver to the user.
 */
 struct mutex user_msgs_mutex;
 struct list_head user_msgs;

 /*
 * Messages queued for processing.  If processing fails (out
 * of memory for instance), They will stay in here to be
 * processed later in a periodic timer interrupt.  The
 * workqueue is for handling received messages directly from
 * the handler.
 */
 spinlock_t       waiting_rcv_msgs_lock;
 struct list_head waiting_rcv_msgs;
 atomic_t  watchdog_pretimeouts_to_deliver;
 struct work_struct smi_work;

 spinlock_t             xmit_msgs_lock;
 struct list_head       xmit_msgs;
 struct ipmi_smi_msg    *curr_msg;
 struct list_head       hp_xmit_msgs;

 /*
 * The list of command receivers that are registered for commands
 * on this interface.
 */
 struct mutex     cmd_rcvrs_mutex;
 struct list_head cmd_rcvrs;

 /*
 * Events that were queues because no one was there to receive
 * them.
 */
 struct mutex     events_mutex; /* For dealing with event stuff. */
 struct list_head waiting_events;
 unsigned int     waiting_events_count; /* How many events in queue? */
 char             event_msg_printed;

 /* How many users are waiting for events? */
 atomic_t         event_waiters;
 unsigned int     ticks_to_req_ev;

 spinlock_t       watch_lock; /* For dealing with watch stuff below. */

 /* How many users are waiting for commands? */
 unsigned int     command_waiters;

 /* How many users are waiting for watchdogs? */
 unsigned int     watchdog_waiters;

 /* How many users are waiting for message responses? */
 unsigned int     response_waiters;

 /*
 * Tells what the lower layer has last been asked to watch for,
 * messages and/or watchdogs.  Protected by watch_lock.
 */
 unsigned int     last_watch_mask;

 /*
 * The event receiver for my BMC, only really used at panic
 * shutdown as a place to store this.
 */
 unsigned char event_receiver;
 unsigned char event_receiver_lun;
 unsigned char local_sel_device;
 unsigned char local_event_generator;

 /* For handling of maintenance mode. */
 int maintenance_mode;
 bool maintenance_mode_enable;
 int auto_maintenance_timeout;
 spinlock_t maintenance_mode_lock; /* Used in a timer... */

 /*
 * If we are doing maintenance on something on IPMB, extend
 * the timeout time to avoid timeouts writing firmware and
 * such.
 */
 int ipmb_maintenance_mode_timeout;

 /*
 * A cheap hack, if this is non-null and a message to an
 * interface comes in with a NULL user, call this routine with
 * it.  Note that the message will still be freed by the
 * caller.  This only works on the system interface.
 *
 * Protected by bmc_reg_mutex.
 */
 void (*null_user_handler)(struct ipmi_smi *intf,
      struct ipmi_recv_msg *msg);

 /*
 * When we are scanning the channels for an SMI, this will
 * tell which channel we are scanning.
 */
 int curr_channel;

 /* Channel information */
 struct ipmi_channel_set *channel_list;
 unsigned int curr_working_cset; /* First index into the following. */
 struct ipmi_channel_set wchannels[2];
 struct ipmi_my_addrinfo addrinfo[IPMI_MAX_CHANNELS];
 bool channels_ready;

 atomic_t stats[IPMI_NUM_STATS];

 /*
 * run_to_completion duplicate of smb_info, smi_info
 * and ipmi_serial_info structures. Used to decrease numbers of
 * parameters passed by "low" level IPMI code.
 */
 int run_to_completion;
};
#define to_si_intf_from_dev(device) container_of(device, struct ipmi_smi, dev)

static void __get_guid(struct ipmi_smi *intf);
static void __ipmi_bmc_unregister(struct ipmi_smi *intf);
static int __ipmi_bmc_register(struct ipmi_smi *intf,
          struct ipmi_device_id *id,
          bool guid_set, guid_t *guid, int intf_num);
static int __scan_channels(struct ipmi_smi *intf, struct ipmi_device_id *id);

static void free_ipmi_user(struct kref *ref)
{
 struct ipmi_user *user = container_of(ref, struct ipmi_user, refcount);
 struct module *owner;

 owner = user->intf->owner;
 kref_put(&user->intf->refcount, intf_free);
 module_put(owner);
 vfree(user);
}

static void release_ipmi_user(struct ipmi_user *user)
{
 kref_put(&user->refcount, free_ipmi_user);
}

static struct ipmi_user *acquire_ipmi_user(struct ipmi_user *user)
{
 if (!kref_get_unless_zero(&user->refcount))
  return NULL;
 return user;
}

/*
 * The driver model view of the IPMI messaging driver.
 */
static struct platform_driver ipmidriver = {
 .driver = {
  .name = "ipmi",
  .bus = &platform_bus_type
 }
};
/*
 * This mutex keeps us from adding the same BMC twice.
 */
static DEFINE_MUTEX(ipmidriver_mutex);

static LIST_HEAD(ipmi_interfaces);
static DEFINE_MUTEX(ipmi_interfaces_mutex);

/*
 * List of watchers that want to know when smi's are added and deleted.
 */
static LIST_HEAD(smi_watchers);
static DEFINE_MUTEX(smi_watchers_mutex);

#define ipmi_inc_stat(intf, stat) \
 atomic_inc(&(intf)->stats[IPMI_STAT_ ## stat])
#define ipmi_get_stat(intf, stat) \
 ((unsigned int) atomic_read(&(intf)->stats[IPMI_STAT_ ## stat]))

static const char * const addr_src_to_str[] = {
 "invalid", "hotmod", "hardcoded", "SPMI", "ACPI", "SMBIOS", "PCI",
 "device-tree", "platform"
};

const char *ipmi_addr_src_to_str(enum ipmi_addr_src src)
{
 if (src >= SI_LAST)
  src = 0; /* Invalid */
 return addr_src_to_str[src];
}
EXPORT_SYMBOL(ipmi_addr_src_to_str);

static int is_lan_addr(struct ipmi_addr *addr)
{
 return addr->addr_type == IPMI_LAN_ADDR_TYPE;
}

static int is_ipmb_addr(struct ipmi_addr *addr)
{
 return addr->addr_type == IPMI_IPMB_ADDR_TYPE;
}

static int is_ipmb_bcast_addr(struct ipmi_addr *addr)
{
 return addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE;
}

static int is_ipmb_direct_addr(struct ipmi_addr *addr)
{
 return addr->addr_type == IPMI_IPMB_DIRECT_ADDR_TYPE;
}

static void free_recv_msg_list(struct list_head *q)
{
 struct ipmi_recv_msg *msg, *msg2;

 list_for_each_entry_safe(msg, msg2, q, link) {
  list_del(&msg->link);
  ipmi_free_recv_msg(msg);
 }
}

static void free_smi_msg_list(struct list_head *q)
{
 struct ipmi_smi_msg *msg, *msg2;

 list_for_each_entry_safe(msg, msg2, q, link) {
  list_del(&msg->link);
  ipmi_free_smi_msg(msg);
 }
}

static void intf_free(struct kref *ref)
{
 struct ipmi_smi *intf = container_of(ref, struct ipmi_smi, refcount);
 int              i;
 struct cmd_rcvr  *rcvr, *rcvr2;

 free_smi_msg_list(&intf->waiting_rcv_msgs);
 free_recv_msg_list(&intf->waiting_events);

 /*
 * Wholesale remove all the entries from the list in the
 * interface.  No need for locks, this is single-threaded.
 */
 list_for_each_entry_safe(rcvr, rcvr2, &intf->cmd_rcvrs, link)
  kfree(rcvr);

 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
  if ((intf->seq_table[i].inuse)
     && (intf->seq_table[i].recv_msg))
   ipmi_free_recv_msg(intf->seq_table[i].recv_msg);
 }

 kfree(intf);
}

int ipmi_smi_watcher_register(struct ipmi_smi_watcher *watcher)
{
 struct ipmi_smi *intf;
 unsigned int count = 0, i;
 int *interfaces = NULL;
 struct device **devices = NULL;
 int rv = 0;

 /*
 * Make sure the driver is actually initialized, this handles
 * problems with initialization order.
 */
 rv = ipmi_init_msghandler();
 if (rv)
  return rv;

 mutex_lock(&smi_watchers_mutex);

 list_add(&watcher->link, &smi_watchers);

 /*
 * Build an array of ipmi interfaces and fill it in, and
 * another array of the devices.  We can't call the callback
 * with ipmi_interfaces_mutex held.  smi_watchers_mutex will
 * keep things in order for the user.
 */
 mutex_lock(&ipmi_interfaces_mutex);
 list_for_each_entry(intf, &ipmi_interfaces, link)
  count++;
 if (count > 0) {
  interfaces = kmalloc_array(count, sizeof(*interfaces),
        GFP_KERNEL);
  if (!interfaces) {
   rv = -ENOMEM;
  } else {
   devices = kmalloc_array(count, sizeof(*devices),
      GFP_KERNEL);
   if (!devices) {
    kfree(interfaces);
    interfaces = NULL;
    rv = -ENOMEM;
   }
  }
  count = 0;
 }
 if (interfaces) {
  list_for_each_entry(intf, &ipmi_interfaces, link) {
   int intf_num = READ_ONCE(intf->intf_num);

   if (intf_num == -1)
    continue;
   devices[count] = intf->si_dev;
   interfaces[count++] = intf_num;
  }
 }
 mutex_unlock(&ipmi_interfaces_mutex);

 if (interfaces) {
  for (i = 0; i < count; i++)
   watcher->new_smi(interfaces[i], devices[i]);
  kfree(interfaces);
  kfree(devices);
 }

 mutex_unlock(&smi_watchers_mutex);

 return rv;
}
EXPORT_SYMBOL(ipmi_smi_watcher_register);

int ipmi_smi_watcher_unregister(struct ipmi_smi_watcher *watcher)
{
 mutex_lock(&smi_watchers_mutex);
 list_del(&watcher->link);
 mutex_unlock(&smi_watchers_mutex);
 return 0;
}
EXPORT_SYMBOL(ipmi_smi_watcher_unregister);

static void
call_smi_watchers(int i, struct device *dev)
{
 struct ipmi_smi_watcher *w;

 list_for_each_entry(w, &smi_watchers, link) {
  if (try_module_get(w->owner)) {
   w->new_smi(i, dev);
   module_put(w->owner);
  }
 }
}

static int
ipmi_addr_equal(struct ipmi_addr *addr1, struct ipmi_addr *addr2)
{
 if (addr1->addr_type != addr2->addr_type)
  return 0;

 if (addr1->channel != addr2->channel)
  return 0;

 if (addr1->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
  struct ipmi_system_interface_addr *smi_addr1
      = (struct ipmi_system_interface_addr *) addr1;
  struct ipmi_system_interface_addr *smi_addr2
      = (struct ipmi_system_interface_addr *) addr2;
  return (smi_addr1->lun == smi_addr2->lun);
 }

 if (is_ipmb_addr(addr1) || is_ipmb_bcast_addr(addr1)) {
  struct ipmi_ipmb_addr *ipmb_addr1
      = (struct ipmi_ipmb_addr *) addr1;
  struct ipmi_ipmb_addr *ipmb_addr2
      = (struct ipmi_ipmb_addr *) addr2;

  return ((ipmb_addr1->slave_addr == ipmb_addr2->slave_addr)
   && (ipmb_addr1->lun == ipmb_addr2->lun));
 }

 if (is_ipmb_direct_addr(addr1)) {
  struct ipmi_ipmb_direct_addr *daddr1
   = (struct ipmi_ipmb_direct_addr *) addr1;
  struct ipmi_ipmb_direct_addr *daddr2
   = (struct ipmi_ipmb_direct_addr *) addr2;

  return daddr1->slave_addr == daddr2->slave_addr &&
   daddr1->rq_lun == daddr2->rq_lun &&
   daddr1->rs_lun == daddr2->rs_lun;
 }

 if (is_lan_addr(addr1)) {
  struct ipmi_lan_addr *lan_addr1
   = (struct ipmi_lan_addr *) addr1;
  struct ipmi_lan_addr *lan_addr2
      = (struct ipmi_lan_addr *) addr2;

  return ((lan_addr1->remote_SWID == lan_addr2->remote_SWID)
   && (lan_addr1->local_SWID == lan_addr2->local_SWID)
   && (lan_addr1->session_handle
       == lan_addr2->session_handle)
   && (lan_addr1->lun == lan_addr2->lun));
 }

 return 1;
}

int ipmi_validate_addr(struct ipmi_addr *addr, int len)
{
 if (len < sizeof(struct ipmi_system_interface_addr))
  return -EINVAL;

 if (addr->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
  if (addr->channel != IPMI_BMC_CHANNEL)
   return -EINVAL;
  return 0;
 }

 if ((addr->channel == IPMI_BMC_CHANNEL)
     || (addr->channel >= IPMI_MAX_CHANNELS)
     || (addr->channel < 0))
  return -EINVAL;

 if (is_ipmb_addr(addr) || is_ipmb_bcast_addr(addr)) {
  if (len < sizeof(struct ipmi_ipmb_addr))
   return -EINVAL;
  return 0;
 }

 if (is_ipmb_direct_addr(addr)) {
  struct ipmi_ipmb_direct_addr *daddr = (void *) addr;

  if (addr->channel != 0)
   return -EINVAL;
  if (len < sizeof(struct ipmi_ipmb_direct_addr))
   return -EINVAL;

  if (daddr->slave_addr & 0x01)
   return -EINVAL;
  if (daddr->rq_lun >= 4)
   return -EINVAL;
  if (daddr->rs_lun >= 4)
   return -EINVAL;
  return 0;
 }

 if (is_lan_addr(addr)) {
  if (len < sizeof(struct ipmi_lan_addr))
   return -EINVAL;
  return 0;
 }

 return -EINVAL;
}
EXPORT_SYMBOL(ipmi_validate_addr);

unsigned int ipmi_addr_length(int addr_type)
{
 if (addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
  return sizeof(struct ipmi_system_interface_addr);

 if ((addr_type == IPMI_IPMB_ADDR_TYPE)
   || (addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE))
  return sizeof(struct ipmi_ipmb_addr);

 if (addr_type == IPMI_IPMB_DIRECT_ADDR_TYPE)
  return sizeof(struct ipmi_ipmb_direct_addr);

 if (addr_type == IPMI_LAN_ADDR_TYPE)
  return sizeof(struct ipmi_lan_addr);

 return 0;
}
EXPORT_SYMBOL(ipmi_addr_length);

static int deliver_response(struct ipmi_smi *intf, struct ipmi_recv_msg *msg)
{
 int rv = 0;

 if (!msg->user) {
  /* Special handling for NULL users. */
  if (intf->null_user_handler) {
   intf->null_user_handler(intf, msg);
  } else {
   /* No handler, so give up. */
   rv = -EINVAL;
  }
  ipmi_free_recv_msg(msg);
 } else if (oops_in_progress) {
  /*
 * If we are running in the panic context, calling the
 * receive handler doesn't much meaning and has a deadlock
 * risk.  At this moment, simply skip it in that case.
 */
  ipmi_free_recv_msg(msg);
 } else {
  /*
 * Deliver it in smi_work.  The message will hold a
 * refcount to the user.
 */
  mutex_lock(&intf->user_msgs_mutex);
  list_add_tail(&msg->link, &intf->user_msgs);
  mutex_unlock(&intf->user_msgs_mutex);
  queue_work(system_wq, &intf->smi_work);
 }

 return rv;
}

static void deliver_local_response(struct ipmi_smi *intf,
       struct ipmi_recv_msg *msg)
{
 if (deliver_response(intf, msg))
  ipmi_inc_stat(intf, unhandled_local_responses);
 else
  ipmi_inc_stat(intf, handled_local_responses);
}

static void deliver_err_response(struct ipmi_smi *intf,
     struct ipmi_recv_msg *msg, int err)
{
 msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
 msg->msg_data[0] = err;
 msg->msg.netfn |= 1; /* Convert to a response. */
 msg->msg.data_len = 1;
 msg->msg.data = msg->msg_data;
 deliver_local_response(intf, msg);
}

static void smi_add_watch(struct ipmi_smi *intf, unsigned int flags)
{
 unsigned long iflags;

 if (!intf->handlers->set_need_watch)
  return;

 spin_lock_irqsave(&intf->watch_lock, iflags);
 if (flags & IPMI_WATCH_MASK_CHECK_MESSAGES)
  intf->response_waiters++;

 if (flags & IPMI_WATCH_MASK_CHECK_WATCHDOG)
  intf->watchdog_waiters++;

 if (flags & IPMI_WATCH_MASK_CHECK_COMMANDS)
  intf->command_waiters++;

 if ((intf->last_watch_mask & flags) != flags) {
  intf->last_watch_mask |= flags;
  intf->handlers->set_need_watch(intf->send_info,
            intf->last_watch_mask);
 }
 spin_unlock_irqrestore(&intf->watch_lock, iflags);
}

static void smi_remove_watch(struct ipmi_smi *intf, unsigned int flags)
{
 unsigned long iflags;

 if (!intf->handlers->set_need_watch)
  return;

 spin_lock_irqsave(&intf->watch_lock, iflags);
 if (flags & IPMI_WATCH_MASK_CHECK_MESSAGES)
  intf->response_waiters--;

 if (flags & IPMI_WATCH_MASK_CHECK_WATCHDOG)
  intf->watchdog_waiters--;

 if (flags & IPMI_WATCH_MASK_CHECK_COMMANDS)
  intf->command_waiters--;

 flags = 0;
 if (intf->response_waiters)
  flags |= IPMI_WATCH_MASK_CHECK_MESSAGES;
 if (intf->watchdog_waiters)
  flags |= IPMI_WATCH_MASK_CHECK_WATCHDOG;
 if (intf->command_waiters)
  flags |= IPMI_WATCH_MASK_CHECK_COMMANDS;

 if (intf->last_watch_mask != flags) {
  intf->last_watch_mask = flags;
  intf->handlers->set_need_watch(intf->send_info,
            intf->last_watch_mask);
 }
 spin_unlock_irqrestore(&intf->watch_lock, iflags);
}

/*
 * Find the next sequence number not being used and add the given
 * message with the given timeout to the sequence table.  This must be
 * called with the interface's seq_lock held.
 */
static int intf_next_seq(struct ipmi_smi      *intf,
    struct ipmi_recv_msg *recv_msg,
    unsigned long        timeout,
    int                  retries,
    int                  broadcast,
    unsigned char        *seq,
    long                 *seqid)
{
 int          rv = 0;
 unsigned int i;

 if (timeout == 0)
  timeout = default_retry_ms;
 if (retries < 0)
  retries = default_max_retries;

 for (i = intf->curr_seq; (i+1)%IPMI_IPMB_NUM_SEQ != intf->curr_seq;
     i = (i+1)%IPMI_IPMB_NUM_SEQ) {
  if (!intf->seq_table[i].inuse)
   break;
 }

 if (!intf->seq_table[i].inuse) {
  intf->seq_table[i].recv_msg = recv_msg;

  /*
 * Start with the maximum timeout, when the send response
 * comes in we will start the real timer.
 */
  intf->seq_table[i].timeout = MAX_MSG_TIMEOUT;
  intf->seq_table[i].orig_timeout = timeout;
  intf->seq_table[i].retries_left = retries;
  intf->seq_table[i].broadcast = broadcast;
  intf->seq_table[i].inuse = 1;
  intf->seq_table[i].seqid = NEXT_SEQID(intf->seq_table[i].seqid);
  *seq = i;
  *seqid = intf->seq_table[i].seqid;
  intf->curr_seq = (i+1)%IPMI_IPMB_NUM_SEQ;
  smi_add_watch(intf, IPMI_WATCH_MASK_CHECK_MESSAGES);
  need_waiter(intf);
 } else {
  rv = -EAGAIN;
 }

 return rv;
}

/*
 * Return the receive message for the given sequence number and
 * release the sequence number so it can be reused.  Some other data
 * is passed in to be sure the message matches up correctly (to help
 * guard against message coming in after their timeout and the
 * sequence number being reused).
 */
static int intf_find_seq(struct ipmi_smi      *intf,
    unsigned char        seq,
    short                channel,
    unsigned char        cmd,
    unsigned char        netfn,
    struct ipmi_addr     *addr,
    struct ipmi_recv_msg **recv_msg)
{
 int           rv = -ENODEV;

 if (seq >= IPMI_IPMB_NUM_SEQ)
  return -EINVAL;

 mutex_lock(&intf->seq_lock);
 if (intf->seq_table[seq].inuse) {
  struct ipmi_recv_msg *msg = intf->seq_table[seq].recv_msg;

  if ((msg->addr.channel == channel) && (msg->msg.cmd == cmd)
    && (msg->msg.netfn == netfn)
    && (ipmi_addr_equal(addr, &msg->addr))) {
   *recv_msg = msg;
   intf->seq_table[seq].inuse = 0;
   smi_remove_watch(intf, IPMI_WATCH_MASK_CHECK_MESSAGES);
   rv = 0;
  }
 }
 mutex_unlock(&intf->seq_lock);

 return rv;
}


/* Start the timer for a specific sequence table entry. */
static int intf_start_seq_timer(struct ipmi_smi *intf,
    long       msgid)
{
 int           rv = -ENODEV;
 unsigned char seq;
 unsigned long seqid;


 GET_SEQ_FROM_MSGID(msgid, seq, seqid);

 mutex_lock(&intf->seq_lock);
 /*
 * We do this verification because the user can be deleted
 * while a message is outstanding.
 */
 if ((intf->seq_table[seq].inuse)
    && (intf->seq_table[seq].seqid == seqid)) {
  struct seq_table *ent = &intf->seq_table[seq];
  ent->timeout = ent->orig_timeout;
  rv = 0;
 }
 mutex_unlock(&intf->seq_lock);

 return rv;
}

/* Got an error for the send message for a specific sequence number. */
static int intf_err_seq(struct ipmi_smi *intf,
   long         msgid,
   unsigned int err)
{
 int                  rv = -ENODEV;
 unsigned char        seq;
 unsigned long        seqid;
 struct ipmi_recv_msg *msg = NULL;


 GET_SEQ_FROM_MSGID(msgid, seq, seqid);

 mutex_lock(&intf->seq_lock);
 /*
 * We do this verification because the user can be deleted
 * while a message is outstanding.
 */
 if ((intf->seq_table[seq].inuse)
    && (intf->seq_table[seq].seqid == seqid)) {
  struct seq_table *ent = &intf->seq_table[seq];

  ent->inuse = 0;
  smi_remove_watch(intf, IPMI_WATCH_MASK_CHECK_MESSAGES);
  msg = ent->recv_msg;
  rv = 0;
 }
 mutex_unlock(&intf->seq_lock);

 if (msg)
  deliver_err_response(intf, msg, err);

 return rv;
}

int ipmi_create_user(unsigned int          if_num,
       const struct ipmi_user_hndl *handler,
       void                  *handler_data,
       struct ipmi_user      **user)
{
 struct ipmi_user *new_user = NULL;
 int           rv = 0;
 struct ipmi_smi *intf;

 /*
 * There is no module usecount here, because it's not
 * required.  Since this can only be used by and called from
 * other modules, they will implicitly use this module, and
 * thus this can't be removed unless the other modules are
 * removed.
 */

 if (handler == NULL)
  return -EINVAL;

 /*
 * Make sure the driver is actually initialized, this handles
 * problems with initialization order.
 */
 rv = ipmi_init_msghandler();
 if (rv)
  return rv;

 mutex_lock(&ipmi_interfaces_mutex);
 list_for_each_entry(intf, &ipmi_interfaces, link) {
  if (intf->intf_num == if_num)
   goto found;
 }
 /* Not found, return an error */
 rv = -EINVAL;
 goto out_unlock;

 found:
 if (intf->in_shutdown) {
  rv = -ENODEV;
  goto out_unlock;
 }

 if (atomic_add_return(1, &intf->nr_users) > max_users) {
  rv = -EBUSY;
  goto out_kfree;
 }

 new_user = vzalloc(sizeof(*new_user));
 if (!new_user) {
  rv = -ENOMEM;
  goto out_kfree;
 }

 if (!try_module_get(intf->owner)) {
  rv = -ENODEV;
  goto out_kfree;
 }

 /* Note that each existing user holds a refcount to the interface. */
 kref_get(&intf->refcount);

 atomic_set(&new_user->nr_msgs, 0);
 kref_init(&new_user->refcount);
 refcount_set(&new_user->destroyed, 1);
 kref_get(&new_user->refcount); /* Destroy owns a refcount. */
 new_user->handler = handler;
 new_user->handler_data = handler_data;
 new_user->intf = intf;
 new_user->gets_events = false;

 mutex_lock(&intf->users_mutex);
 mutex_lock(&intf->seq_lock);
 list_add(&new_user->link, &intf->users);
 mutex_unlock(&intf->seq_lock);
 mutex_unlock(&intf->users_mutex);

 if (handler->ipmi_watchdog_pretimeout)
  /* User wants pretimeouts, so make sure to watch for them. */
  smi_add_watch(intf, IPMI_WATCH_MASK_CHECK_WATCHDOG);

out_kfree:
 if (rv) {
  atomic_dec(&intf->nr_users);
  vfree(new_user);
 } else {
  *user = new_user;
 }
out_unlock:
 mutex_unlock(&ipmi_interfaces_mutex);
 return rv;
}
EXPORT_SYMBOL(ipmi_create_user);

int ipmi_get_smi_info(int if_num, struct ipmi_smi_info *data)
{
 int rv = -EINVAL;
 struct ipmi_smi *intf;

 mutex_lock(&ipmi_interfaces_mutex);
 list_for_each_entry(intf, &ipmi_interfaces, link) {
  if (intf->intf_num == if_num) {
   if (!intf->handlers->get_smi_info)
    rv = -ENOTTY;
   else
    rv = intf->handlers->get_smi_info(intf->send_info, data);
   break;
  }
 }
 mutex_unlock(&ipmi_interfaces_mutex);

 return rv;
}
EXPORT_SYMBOL(ipmi_get_smi_info);

/* Must be called with intf->users_mutex held. */
static void _ipmi_destroy_user(struct ipmi_user *user)
{
 struct ipmi_smi  *intf = user->intf;
 int              i;
 struct cmd_rcvr  *rcvr;
 struct cmd_rcvr  *rcvrs = NULL;
 struct ipmi_recv_msg *msg, *msg2;

 if (!refcount_dec_if_one(&user->destroyed))
  return;

 if (user->handler->shutdown)
  user->handler->shutdown(user->handler_data);

 if (user->handler->ipmi_watchdog_pretimeout)
  smi_remove_watch(intf, IPMI_WATCH_MASK_CHECK_WATCHDOG);

 if (user->gets_events)
  atomic_dec(&intf->event_waiters);

 /* Remove the user from the interface's list and sequence table. */
 list_del(&user->link);
 atomic_dec(&intf->nr_users);

 mutex_lock(&intf->seq_lock);
 for (i = 0; i < IPMI_IPMB_NUM_SEQ; i++) {
  if (intf->seq_table[i].inuse
      && (intf->seq_table[i].recv_msg->user == user)) {
   intf->seq_table[i].inuse = 0;
   smi_remove_watch(intf, IPMI_WATCH_MASK_CHECK_MESSAGES);
   ipmi_free_recv_msg(intf->seq_table[i].recv_msg);
  }
 }
 mutex_unlock(&intf->seq_lock);

 /*
 * Remove the user from the command receiver's table.  First
 * we build a list of everything (not using the standard link,
 * since other things may be using it till we do
 * synchronize_rcu()) then free everything in that list.
 */
 mutex_lock(&intf->cmd_rcvrs_mutex);
 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link,
    lockdep_is_held(&intf->cmd_rcvrs_mutex)) {
  if (rcvr->user == user) {
   list_del_rcu(&rcvr->link);
   rcvr->next = rcvrs;
   rcvrs = rcvr;
  }
 }
 mutex_unlock(&intf->cmd_rcvrs_mutex);
 while (rcvrs) {
  rcvr = rcvrs;
  rcvrs = rcvr->next;
  kfree(rcvr);
 }

 mutex_lock(&intf->user_msgs_mutex);
 list_for_each_entry_safe(msg, msg2, &intf->user_msgs, link) {
  if (msg->user != user)
   continue;
  list_del(&msg->link);
  ipmi_free_recv_msg(msg);
 }
 mutex_unlock(&intf->user_msgs_mutex);

 release_ipmi_user(user);
}

void ipmi_destroy_user(struct ipmi_user *user)
{
 struct ipmi_smi *intf = user->intf;

 mutex_lock(&intf->users_mutex);
 _ipmi_destroy_user(user);
 mutex_unlock(&intf->users_mutex);

 kref_put(&user->refcount, free_ipmi_user);
}
EXPORT_SYMBOL(ipmi_destroy_user);

int ipmi_get_version(struct ipmi_user *user,
       unsigned char *major,
       unsigned char *minor)
{
 struct ipmi_device_id id;
 int rv;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 rv = bmc_get_device_id(user->intf, NULL, &id, NULL, NULL);
 if (!rv) {
  *major = ipmi_version_major(&id);
  *minor = ipmi_version_minor(&id);
 }
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_get_version);

int ipmi_set_my_address(struct ipmi_user *user,
   unsigned int  channel,
   unsigned char address)
{
 int rv = 0;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 if (channel >= IPMI_MAX_CHANNELS) {
  rv = -EINVAL;
 } else {
  channel = array_index_nospec(channel, IPMI_MAX_CHANNELS);
  user->intf->addrinfo[channel].address = address;
 }
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_set_my_address);

int ipmi_get_my_address(struct ipmi_user *user,
   unsigned int  channel,
   unsigned char *address)
{
 int rv = 0;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 if (channel >= IPMI_MAX_CHANNELS) {
  rv = -EINVAL;
 } else {
  channel = array_index_nospec(channel, IPMI_MAX_CHANNELS);
  *address = user->intf->addrinfo[channel].address;
 }
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_get_my_address);

int ipmi_set_my_LUN(struct ipmi_user *user,
      unsigned int  channel,
      unsigned char LUN)
{
 int rv = 0;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 if (channel >= IPMI_MAX_CHANNELS) {
  rv = -EINVAL;
 } else {
  channel = array_index_nospec(channel, IPMI_MAX_CHANNELS);
  user->intf->addrinfo[channel].lun = LUN & 0x3;
 }
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_set_my_LUN);

int ipmi_get_my_LUN(struct ipmi_user *user,
      unsigned int  channel,
      unsigned char *address)
{
 int rv = 0;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 if (channel >= IPMI_MAX_CHANNELS) {
  rv = -EINVAL;
 } else {
  channel = array_index_nospec(channel, IPMI_MAX_CHANNELS);
  *address = user->intf->addrinfo[channel].lun;
 }
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_get_my_LUN);

int ipmi_get_maintenance_mode(struct ipmi_user *user)
{
 int mode;
 unsigned long flags;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 spin_lock_irqsave(&user->intf->maintenance_mode_lock, flags);
 mode = user->intf->maintenance_mode;
 spin_unlock_irqrestore(&user->intf->maintenance_mode_lock, flags);
 release_ipmi_user(user);

 return mode;
}
EXPORT_SYMBOL(ipmi_get_maintenance_mode);

static void maintenance_mode_update(struct ipmi_smi *intf)
{
 if (intf->handlers->set_maintenance_mode)
  intf->handlers->set_maintenance_mode(
   intf->send_info, intf->maintenance_mode_enable);
}

int ipmi_set_maintenance_mode(struct ipmi_user *user, int mode)
{
 int rv = 0;
 unsigned long flags;
 struct ipmi_smi *intf = user->intf;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
 if (intf->maintenance_mode != mode) {
  switch (mode) {
  case IPMI_MAINTENANCE_MODE_AUTO:
   intf->maintenance_mode_enable
    = (intf->auto_maintenance_timeout > 0);
   break;

  case IPMI_MAINTENANCE_MODE_OFF:
   intf->maintenance_mode_enable = false;
   break;

  case IPMI_MAINTENANCE_MODE_ON:
   intf->maintenance_mode_enable = true;
   break;

  default:
   rv = -EINVAL;
   goto out_unlock;
  }
  intf->maintenance_mode = mode;

  maintenance_mode_update(intf);
 }
 out_unlock:
 spin_unlock_irqrestore(&intf->maintenance_mode_lock, flags);
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_set_maintenance_mode);

int ipmi_set_gets_events(struct ipmi_user *user, bool val)
{
 struct ipmi_smi      *intf = user->intf;
 struct ipmi_recv_msg *msg, *msg2;
 struct list_head     msgs;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 INIT_LIST_HEAD(&msgs);

 mutex_lock(&intf->events_mutex);
 if (user->gets_events == val)
  goto out;

 user->gets_events = val;

 if (val) {
  if (atomic_inc_return(&intf->event_waiters) == 1)
   need_waiter(intf);
 } else {
  atomic_dec(&intf->event_waiters);
 }

 /* Deliver any queued events. */
 while (user->gets_events && !list_empty(&intf->waiting_events)) {
  list_for_each_entry_safe(msg, msg2, &intf->waiting_events, link)
   list_move_tail(&msg->link, &msgs);
  intf->waiting_events_count = 0;
  if (intf->event_msg_printed) {
   dev_warn(intf->si_dev, "Event queue no longer full\n");
   intf->event_msg_printed = 0;
  }

  list_for_each_entry_safe(msg, msg2, &msgs, link) {
   ipmi_set_recv_msg_user(msg, user);
   deliver_local_response(intf, msg);
  }
 }

 out:
 mutex_unlock(&intf->events_mutex);
 release_ipmi_user(user);

 return 0;
}
EXPORT_SYMBOL(ipmi_set_gets_events);

static struct cmd_rcvr *find_cmd_rcvr(struct ipmi_smi *intf,
          unsigned char netfn,
          unsigned char cmd,
          unsigned char chan)
{
 struct cmd_rcvr *rcvr;

 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link,
    lockdep_is_held(&intf->cmd_rcvrs_mutex)) {
  if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
     && (rcvr->chans & (1 << chan)))
   return rcvr;
 }
 return NULL;
}

static int is_cmd_rcvr_exclusive(struct ipmi_smi *intf,
     unsigned char netfn,
     unsigned char cmd,
     unsigned int  chans)
{
 struct cmd_rcvr *rcvr;

 list_for_each_entry_rcu(rcvr, &intf->cmd_rcvrs, link,
    lockdep_is_held(&intf->cmd_rcvrs_mutex)) {
  if ((rcvr->netfn == netfn) && (rcvr->cmd == cmd)
     && (rcvr->chans & chans))
   return 0;
 }
 return 1;
}

int ipmi_register_for_cmd(struct ipmi_user *user,
     unsigned char netfn,
     unsigned char cmd,
     unsigned int  chans)
{
 struct ipmi_smi *intf = user->intf;
 struct cmd_rcvr *rcvr;
 int rv = 0;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 rcvr = kmalloc(sizeof(*rcvr), GFP_KERNEL);
 if (!rcvr) {
  rv = -ENOMEM;
  goto out_release;
 }
 rcvr->cmd = cmd;
 rcvr->netfn = netfn;
 rcvr->chans = chans;
 rcvr->user = user;

 mutex_lock(&intf->cmd_rcvrs_mutex);
 /* Make sure the command/netfn is not already registered. */
 if (!is_cmd_rcvr_exclusive(intf, netfn, cmd, chans)) {
  rv = -EBUSY;
  goto out_unlock;
 }

 smi_add_watch(intf, IPMI_WATCH_MASK_CHECK_COMMANDS);

 list_add_rcu(&rcvr->link, &intf->cmd_rcvrs);

out_unlock:
 mutex_unlock(&intf->cmd_rcvrs_mutex);
 if (rv)
  kfree(rcvr);
out_release:
 release_ipmi_user(user);

 return rv;
}
EXPORT_SYMBOL(ipmi_register_for_cmd);

int ipmi_unregister_for_cmd(struct ipmi_user *user,
       unsigned char netfn,
       unsigned char cmd,
       unsigned int  chans)
{
 struct ipmi_smi *intf = user->intf;
 struct cmd_rcvr *rcvr;
 struct cmd_rcvr *rcvrs = NULL;
 int i, rv = -ENOENT;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 mutex_lock(&intf->cmd_rcvrs_mutex);
 for (i = 0; i < IPMI_NUM_CHANNELS; i++) {
  if (((1 << i) & chans) == 0)
   continue;
  rcvr = find_cmd_rcvr(intf, netfn, cmd, i);
  if (rcvr == NULL)
   continue;
  if (rcvr->user == user) {
   rv = 0;
   rcvr->chans &= ~chans;
   if (rcvr->chans == 0) {
    list_del_rcu(&rcvr->link);
    rcvr->next = rcvrs;
    rcvrs = rcvr;
   }
  }
 }
 mutex_unlock(&intf->cmd_rcvrs_mutex);
 synchronize_rcu();
 release_ipmi_user(user);
 while (rcvrs) {
  smi_remove_watch(intf, IPMI_WATCH_MASK_CHECK_COMMANDS);
  rcvr = rcvrs;
  rcvrs = rcvr->next;
  kfree(rcvr);
 }

 return rv;
}
EXPORT_SYMBOL(ipmi_unregister_for_cmd);

unsigned char
ipmb_checksum(unsigned char *data, int size)
{
 unsigned char csum = 0;

 for (; size > 0; size--, data++)
  csum += *data;

 return -csum;
}
EXPORT_SYMBOL(ipmb_checksum);

static inline void format_ipmb_msg(struct ipmi_smi_msg   *smi_msg,
       struct kernel_ipmi_msg *msg,
       struct ipmi_ipmb_addr *ipmb_addr,
       long                  msgid,
       unsigned char         ipmb_seq,
       int                   broadcast,
       unsigned char         source_address,
       unsigned char         source_lun)
{
 int i = broadcast;

 /* Format the IPMB header data. */
 smi_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
 smi_msg->data[1] = IPMI_SEND_MSG_CMD;
 smi_msg->data[2] = ipmb_addr->channel;
 if (broadcast)
  smi_msg->data[3] = 0;
 smi_msg->data[i+3] = ipmb_addr->slave_addr;
 smi_msg->data[i+4] = (msg->netfn << 2) | (ipmb_addr->lun & 0x3);
 smi_msg->data[i+5] = ipmb_checksum(&smi_msg->data[i + 3], 2);
 smi_msg->data[i+6] = source_address;
 smi_msg->data[i+7] = (ipmb_seq << 2) | source_lun;
 smi_msg->data[i+8] = msg->cmd;

 /* Now tack on the data to the message. */
 if (msg->data_len > 0)
  memcpy(&smi_msg->data[i + 9], msg->data, msg->data_len);
 smi_msg->data_size = msg->data_len + 9;

 /* Now calculate the checksum and tack it on. */
 smi_msg->data[i+smi_msg->data_size]
  = ipmb_checksum(&smi_msg->data[i + 6], smi_msg->data_size - 6);

 /*
 * Add on the checksum size and the offset from the
 * broadcast.
 */
 smi_msg->data_size += 1 + i;

 smi_msg->msgid = msgid;
}

static inline void format_lan_msg(struct ipmi_smi_msg   *smi_msg,
      struct kernel_ipmi_msg *msg,
      struct ipmi_lan_addr  *lan_addr,
      long                  msgid,
      unsigned char         ipmb_seq,
      unsigned char         source_lun)
{
 /* Format the IPMB header data. */
 smi_msg->data[0] = (IPMI_NETFN_APP_REQUEST << 2);
 smi_msg->data[1] = IPMI_SEND_MSG_CMD;
 smi_msg->data[2] = lan_addr->channel;
 smi_msg->data[3] = lan_addr->session_handle;
 smi_msg->data[4] = lan_addr->remote_SWID;
 smi_msg->data[5] = (msg->netfn << 2) | (lan_addr->lun & 0x3);
 smi_msg->data[6] = ipmb_checksum(&smi_msg->data[4], 2);
 smi_msg->data[7] = lan_addr->local_SWID;
 smi_msg->data[8] = (ipmb_seq << 2) | source_lun;
 smi_msg->data[9] = msg->cmd;

 /* Now tack on the data to the message. */
 if (msg->data_len > 0)
  memcpy(&smi_msg->data[10], msg->data, msg->data_len);
 smi_msg->data_size = msg->data_len + 10;

 /* Now calculate the checksum and tack it on. */
 smi_msg->data[smi_msg->data_size]
  = ipmb_checksum(&smi_msg->data[7], smi_msg->data_size - 7);

 /*
 * Add on the checksum size and the offset from the
 * broadcast.
 */
 smi_msg->data_size += 1;

 smi_msg->msgid = msgid;
}

static struct ipmi_smi_msg *smi_add_send_msg(struct ipmi_smi *intf,
          struct ipmi_smi_msg *smi_msg,
          int priority)
{
 if (intf->curr_msg) {
  if (priority > 0)
   list_add_tail(&smi_msg->link, &intf->hp_xmit_msgs);
  else
   list_add_tail(&smi_msg->link, &intf->xmit_msgs);
  smi_msg = NULL;
 } else {
  intf->curr_msg = smi_msg;
 }

 return smi_msg;
}

static void smi_send(struct ipmi_smi *intf,
       const struct ipmi_smi_handlers *handlers,
       struct ipmi_smi_msg *smi_msg, int priority)
{
 int run_to_completion = READ_ONCE(intf->run_to_completion);
 unsigned long flags = 0;

 if (!run_to_completion)
  spin_lock_irqsave(&intf->xmit_msgs_lock, flags);
 smi_msg = smi_add_send_msg(intf, smi_msg, priority);
 if (!run_to_completion)
  spin_unlock_irqrestore(&intf->xmit_msgs_lock, flags);

 if (smi_msg)
  handlers->sender(intf->send_info, smi_msg);
}

static bool is_maintenance_mode_cmd(struct kernel_ipmi_msg *msg)
{
 return (((msg->netfn == IPMI_NETFN_APP_REQUEST)
   && ((msg->cmd == IPMI_COLD_RESET_CMD)
       || (msg->cmd == IPMI_WARM_RESET_CMD)))
  || (msg->netfn == IPMI_NETFN_FIRMWARE_REQUEST));
}

static int i_ipmi_req_sysintf(struct ipmi_smi        *intf,
         struct ipmi_addr       *addr,
         long                   msgid,
         struct kernel_ipmi_msg *msg,
         struct ipmi_smi_msg    *smi_msg,
         struct ipmi_recv_msg   *recv_msg,
         int                    retries,
         unsigned int           retry_time_ms)
{
 struct ipmi_system_interface_addr *smi_addr;

 if (msg->netfn & 1)
  /* Responses are not allowed to the SMI. */
  return -EINVAL;

 smi_addr = (struct ipmi_system_interface_addr *) addr;
 if (smi_addr->lun > 3) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 memcpy(&recv_msg->addr, smi_addr, sizeof(*smi_addr));

 if ((msg->netfn == IPMI_NETFN_APP_REQUEST)
     && ((msg->cmd == IPMI_SEND_MSG_CMD)
  || (msg->cmd == IPMI_GET_MSG_CMD)
  || (msg->cmd == IPMI_READ_EVENT_MSG_BUFFER_CMD))) {
  /*
 * We don't let the user do these, since we manage
 * the sequence numbers.
 */
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 if (is_maintenance_mode_cmd(msg)) {
  unsigned long flags;

  spin_lock_irqsave(&intf->maintenance_mode_lock, flags);
  intf->auto_maintenance_timeout
   = maintenance_mode_timeout_ms;
  if (!intf->maintenance_mode
      && !intf->maintenance_mode_enable) {
   intf->maintenance_mode_enable = true;
   maintenance_mode_update(intf);
  }
  spin_unlock_irqrestore(&intf->maintenance_mode_lock,
           flags);
 }

 if (msg->data_len + 2 > IPMI_MAX_MSG_LENGTH) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EMSGSIZE;
 }

 smi_msg->data[0] = (msg->netfn << 2) | (smi_addr->lun & 0x3);
 smi_msg->data[1] = msg->cmd;
 smi_msg->msgid = msgid;
 smi_msg->user_data = recv_msg;
 if (msg->data_len > 0)
  memcpy(&smi_msg->data[2], msg->data, msg->data_len);
 smi_msg->data_size = msg->data_len + 2;
 ipmi_inc_stat(intf, sent_local_commands);

 return 0;
}

static int i_ipmi_req_ipmb(struct ipmi_smi        *intf,
      struct ipmi_addr       *addr,
      long                   msgid,
      struct kernel_ipmi_msg *msg,
      struct ipmi_smi_msg    *smi_msg,
      struct ipmi_recv_msg   *recv_msg,
      unsigned char          source_address,
      unsigned char          source_lun,
      int                    retries,
      unsigned int           retry_time_ms)
{
 struct ipmi_ipmb_addr *ipmb_addr;
 unsigned char ipmb_seq;
 long seqid;
 int broadcast = 0;
 struct ipmi_channel *chans;
 int rv = 0;

 if (addr->channel >= IPMI_MAX_CHANNELS) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 chans = READ_ONCE(intf->channel_list)->c;

 if (chans[addr->channel].medium != IPMI_CHANNEL_MEDIUM_IPMB) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 if (addr->addr_type == IPMI_IPMB_BROADCAST_ADDR_TYPE) {
  /*
 * Broadcasts add a zero at the beginning of the
 * message, but otherwise is the same as an IPMB
 * address.
 */
  addr->addr_type = IPMI_IPMB_ADDR_TYPE;
  broadcast = 1;
  retries = 0; /* Don't retry broadcasts. */
 }

 /*
 * 9 for the header and 1 for the checksum, plus
 * possibly one for the broadcast.
 */
 if ((msg->data_len + 10 + broadcast) > IPMI_MAX_MSG_LENGTH) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EMSGSIZE;
 }

 ipmb_addr = (struct ipmi_ipmb_addr *) addr;
 if (ipmb_addr->lun > 3) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 memcpy(&recv_msg->addr, ipmb_addr, sizeof(*ipmb_addr));

 if (recv_msg->msg.netfn & 0x1) {
  /*
 * It's a response, so use the user's sequence
 * from msgid.
 */
  ipmi_inc_stat(intf, sent_ipmb_responses);
  format_ipmb_msg(smi_msg, msg, ipmb_addr, msgid,
    msgid, broadcast,
    source_address, source_lun);

  /*
 * Save the receive message so we can use it
 * to deliver the response.
 */
  smi_msg->user_data = recv_msg;
 } else {
  mutex_lock(&intf->seq_lock);

  if (is_maintenance_mode_cmd(msg))
   intf->ipmb_maintenance_mode_timeout =
    maintenance_mode_timeout_ms;

  if (intf->ipmb_maintenance_mode_timeout && retry_time_ms == 0)
   /* Different default in maintenance mode */
   retry_time_ms = default_maintenance_retry_ms;

  /*
 * Create a sequence number with a 1 second
 * timeout and 4 retries.
 */
  rv = intf_next_seq(intf,
       recv_msg,
       retry_time_ms,
       retries,
       broadcast,
       &ipmb_seq,
       &seqid);
  if (rv)
   /*
 * We have used up all the sequence numbers,
 * probably, so abort.
 */
   goto out_err;

  ipmi_inc_stat(intf, sent_ipmb_commands);

  /*
 * Store the sequence number in the message,
 * so that when the send message response
 * comes back we can start the timer.
 */
  format_ipmb_msg(smi_msg, msg, ipmb_addr,
    STORE_SEQ_IN_MSGID(ipmb_seq, seqid),
    ipmb_seq, broadcast,
    source_address, source_lun);

  /*
 * Copy the message into the recv message data, so we
 * can retransmit it later if necessary.
 */
  memcpy(recv_msg->msg_data, smi_msg->data,
         smi_msg->data_size);
  recv_msg->msg.data = recv_msg->msg_data;
  recv_msg->msg.data_len = smi_msg->data_size;

  /*
 * We don't unlock until here, because we need
 * to copy the completed message into the
 * recv_msg before we release the lock.
 * Otherwise, race conditions may bite us.  I
 * know that's pretty paranoid, but I prefer
 * to be correct.
 */
out_err:
  mutex_unlock(&intf->seq_lock);
 }

 return rv;
}

static int i_ipmi_req_ipmb_direct(struct ipmi_smi        *intf,
      struct ipmi_addr       *addr,
      long    msgid,
      struct kernel_ipmi_msg *msg,
      struct ipmi_smi_msg    *smi_msg,
      struct ipmi_recv_msg   *recv_msg,
      unsigned char          source_lun)
{
 struct ipmi_ipmb_direct_addr *daddr;
 bool is_cmd = !(recv_msg->msg.netfn & 0x1);

 if (!(intf->handlers->flags & IPMI_SMI_CAN_HANDLE_IPMB_DIRECT))
  return -EAFNOSUPPORT;

 /* Responses must have a completion code. */
 if (!is_cmd && msg->data_len < 1) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 if ((msg->data_len + 4) > IPMI_MAX_MSG_LENGTH) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EMSGSIZE;
 }

 daddr = (struct ipmi_ipmb_direct_addr *) addr;
 if (daddr->rq_lun > 3 || daddr->rs_lun > 3) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 smi_msg->type = IPMI_SMI_MSG_TYPE_IPMB_DIRECT;
 smi_msg->msgid = msgid;

 if (is_cmd) {
  smi_msg->data[0] = msg->netfn << 2 | daddr->rs_lun;
  smi_msg->data[2] = recv_msg->msgid << 2 | daddr->rq_lun;
 } else {
  smi_msg->data[0] = msg->netfn << 2 | daddr->rq_lun;
  smi_msg->data[2] = recv_msg->msgid << 2 | daddr->rs_lun;
 }
 smi_msg->data[1] = daddr->slave_addr;
 smi_msg->data[3] = msg->cmd;

 memcpy(smi_msg->data + 4, msg->data, msg->data_len);
 smi_msg->data_size = msg->data_len + 4;

 smi_msg->user_data = recv_msg;

 return 0;
}

static int i_ipmi_req_lan(struct ipmi_smi        *intf,
     struct ipmi_addr       *addr,
     long                   msgid,
     struct kernel_ipmi_msg *msg,
     struct ipmi_smi_msg    *smi_msg,
     struct ipmi_recv_msg   *recv_msg,
     unsigned char          source_lun,
     int                    retries,
     unsigned int           retry_time_ms)
{
 struct ipmi_lan_addr  *lan_addr;
 unsigned char ipmb_seq;
 long seqid;
 struct ipmi_channel *chans;
 int rv = 0;

 if (addr->channel >= IPMI_MAX_CHANNELS) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 chans = READ_ONCE(intf->channel_list)->c;

 if ((chans[addr->channel].medium
    != IPMI_CHANNEL_MEDIUM_8023LAN)
   && (chans[addr->channel].medium
       != IPMI_CHANNEL_MEDIUM_ASYNC)) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 /* 11 for the header and 1 for the checksum. */
 if ((msg->data_len + 12) > IPMI_MAX_MSG_LENGTH) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EMSGSIZE;
 }

 lan_addr = (struct ipmi_lan_addr *) addr;
 if (lan_addr->lun > 3) {
  ipmi_inc_stat(intf, sent_invalid_commands);
  return -EINVAL;
 }

 memcpy(&recv_msg->addr, lan_addr, sizeof(*lan_addr));

 if (recv_msg->msg.netfn & 0x1) {
  /*
 * It's a response, so use the user's sequence
 * from msgid.
 */
  ipmi_inc_stat(intf, sent_lan_responses);
  format_lan_msg(smi_msg, msg, lan_addr, msgid,
          msgid, source_lun);

  /*
 * Save the receive message so we can use it
 * to deliver the response.
 */
  smi_msg->user_data = recv_msg;
 } else {
  mutex_lock(&intf->seq_lock);

  /*
 * Create a sequence number with a 1 second
 * timeout and 4 retries.
 */
  rv = intf_next_seq(intf,
       recv_msg,
       retry_time_ms,
       retries,
       0,
       &ipmb_seq,
       &seqid);
  if (rv)
   /*
 * We have used up all the sequence numbers,
 * probably, so abort.
 */
   goto out_err;

  ipmi_inc_stat(intf, sent_lan_commands);

  /*
 * Store the sequence number in the message,
 * so that when the send message response
 * comes back we can start the timer.
 */
  format_lan_msg(smi_msg, msg, lan_addr,
          STORE_SEQ_IN_MSGID(ipmb_seq, seqid),
          ipmb_seq, source_lun);

  /*
 * Copy the message into the recv message data, so we
 * can retransmit it later if necessary.
 */
  memcpy(recv_msg->msg_data, smi_msg->data,
         smi_msg->data_size);
  recv_msg->msg.data = recv_msg->msg_data;
  recv_msg->msg.data_len = smi_msg->data_size;

  /*
 * We don't unlock until here, because we need
 * to copy the completed message into the
 * recv_msg before we release the lock.
 * Otherwise, race conditions may bite us.  I
 * know that's pretty paranoid, but I prefer
 * to be correct.
 */
out_err:
  mutex_unlock(&intf->seq_lock);
 }

 return rv;
}

/*
 * Separate from ipmi_request so that the user does not have to be
 * supplied in certain circumstances (mainly at panic time).  If
 * messages are supplied, they will be freed, even if an error
 * occurs.
 */
static int i_ipmi_request(struct ipmi_user     *user,
     struct ipmi_smi      *intf,
     struct ipmi_addr     *addr,
     long                 msgid,
     struct kernel_ipmi_msg *msg,
     void                 *user_msg_data,
     void                 *supplied_smi,
     struct ipmi_recv_msg *supplied_recv,
     int                  priority,
     unsigned char        source_address,
     unsigned char        source_lun,
     int                  retries,
     unsigned int         retry_time_ms)
{
 struct ipmi_smi_msg *smi_msg;
 struct ipmi_recv_msg *recv_msg;
 int run_to_completion = READ_ONCE(intf->run_to_completion);
 int rv = 0;

 if (supplied_recv) {
  recv_msg = supplied_recv;
  recv_msg->user = user;
  if (user) {
   atomic_inc(&user->nr_msgs);
   /* The put happens when the message is freed. */
   kref_get(&user->refcount);
  }
 } else {
  recv_msg = ipmi_alloc_recv_msg(user);
  if (IS_ERR(recv_msg))
   return PTR_ERR(recv_msg);
 }
 recv_msg->user_msg_data = user_msg_data;

 if (supplied_smi)
  smi_msg = supplied_smi;
 else {
  smi_msg = ipmi_alloc_smi_msg();
  if (smi_msg == NULL) {
   if (!supplied_recv)
    ipmi_free_recv_msg(recv_msg);
   return -ENOMEM;
  }
 }

 if (!run_to_completion)
  mutex_lock(&intf->users_mutex);
 if (intf->in_shutdown) {
  rv = -ENODEV;
  goto out_err;
 }

 recv_msg->msgid = msgid;
 /*
 * Store the message to send in the receive message so timeout
 * responses can get the proper response data.
 */
 recv_msg->msg = *msg;

 if (addr->addr_type == IPMI_SYSTEM_INTERFACE_ADDR_TYPE) {
  rv = i_ipmi_req_sysintf(intf, addr, msgid, msg, smi_msg,
     recv_msg, retries, retry_time_ms);
 } else if (is_ipmb_addr(addr) || is_ipmb_bcast_addr(addr)) {
  rv = i_ipmi_req_ipmb(intf, addr, msgid, msg, smi_msg, recv_msg,
         source_address, source_lun,
         retries, retry_time_ms);
 } else if (is_ipmb_direct_addr(addr)) {
  rv = i_ipmi_req_ipmb_direct(intf, addr, msgid, msg, smi_msg,
         recv_msg, source_lun);
 } else if (is_lan_addr(addr)) {
  rv = i_ipmi_req_lan(intf, addr, msgid, msg, smi_msg, recv_msg,
        source_lun, retries, retry_time_ms);
 } else {
     /* Unknown address type. */
  ipmi_inc_stat(intf, sent_invalid_commands);
  rv = -EINVAL;
 }

 if (rv) {
out_err:
  if (!supplied_smi)
   ipmi_free_smi_msg(smi_msg);
  if (!supplied_recv)
   ipmi_free_recv_msg(recv_msg);
 } else {
  dev_dbg(intf->si_dev, "Send: %*ph\n",
   smi_msg->data_size, smi_msg->data);

  smi_send(intf, intf->handlers, smi_msg, priority);
 }
 if (!run_to_completion)
  mutex_unlock(&intf->users_mutex);

 return rv;
}

static int check_addr(struct ipmi_smi  *intf,
        struct ipmi_addr *addr,
        unsigned char    *saddr,
        unsigned char    *lun)
{
 if (addr->channel >= IPMI_MAX_CHANNELS)
  return -EINVAL;
 addr->channel = array_index_nospec(addr->channel, IPMI_MAX_CHANNELS);
 *lun = intf->addrinfo[addr->channel].lun;
 *saddr = intf->addrinfo[addr->channel].address;
 return 0;
}

int ipmi_request_settime(struct ipmi_user *user,
    struct ipmi_addr *addr,
    long             msgid,
    struct kernel_ipmi_msg  *msg,
    void             *user_msg_data,
    int              priority,
    int              retries,
    unsigned int     retry_time_ms)
{
 unsigned char saddr = 0, lun = 0;
 int rv;

 if (!user)
  return -EINVAL;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 rv = check_addr(user->intf, addr, &saddr, &lun);
 if (!rv)
  rv = i_ipmi_request(user,
        user->intf,
        addr,
        msgid,
        msg,
        user_msg_data,
        NULL, NULL,
        priority,
        saddr,
        lun,
        retries,
        retry_time_ms);

 release_ipmi_user(user);
 return rv;
}
EXPORT_SYMBOL(ipmi_request_settime);

int ipmi_request_supply_msgs(struct ipmi_user     *user,
        struct ipmi_addr     *addr,
        long                 msgid,
        struct kernel_ipmi_msg *msg,
        void                 *user_msg_data,
        void                 *supplied_smi,
        struct ipmi_recv_msg *supplied_recv,
        int                  priority)
{
 unsigned char saddr = 0, lun = 0;
 int rv;

 if (!user)
  return -EINVAL;

 user = acquire_ipmi_user(user);
 if (!user)
  return -ENODEV;

 rv = check_addr(user->intf, addr, &saddr, &lun);
 if (!rv)
  rv = i_ipmi_request(user,
        user->intf,
        addr,
        msgid,
        msg,
        user_msg_data,
        supplied_smi,
        supplied_recv,
        priority,
        saddr,
        lun,
        -1, 0);

 release_ipmi_user(user);
 return rv;
}
EXPORT_SYMBOL(ipmi_request_supply_msgs);

static void bmc_device_id_handler(struct ipmi_smi *intf,
      struct ipmi_recv_msg *msg)
{
 int rv;

 if ((msg->addr.addr_type != IPMI_SYSTEM_INTERFACE_ADDR_TYPE)
   || (msg->msg.netfn != IPMI_NETFN_APP_RESPONSE)
   || (msg->msg.cmd != IPMI_GET_DEVICE_ID_CMD)) {
  dev_warn(intf->si_dev,
    "invalid device_id msg: addr_type=%d netfn=%x cmd=%x\n",
    msg->addr.addr_type, msg->msg.netfn, msg->msg.cmd);
  return;
 }

 if (msg->msg.data[0]) {
  dev_warn(intf->si_dev, "device id fetch failed: 0x%2.2x\n",
    msg->msg.data[0]);
  intf->bmc->dyn_id_set = 0;
  goto out;
 }

 rv = ipmi_demangle_device_id(msg->msg.netfn, msg->msg.cmd,
   msg->msg.data, msg->msg.data_len, &intf->bmc->fetch_id);
 if (rv) {
  dev_warn(intf->si_dev, "device id demangle failed: %d\n", rv);
  /* record completion code when error */
  intf->bmc->cc = msg->msg.data[0];
  intf->bmc->dyn_id_set = 0;
 } else {
  /*
 * Make sure the id data is available before setting
 * dyn_id_set.
 */
  smp_wmb();
  intf->bmc->dyn_id_set = 1;
 }
out:
 wake_up(&intf->waitq);
}

static int
send_get_device_id_cmd(struct ipmi_smi *intf)
{
 struct ipmi_system_interface_addr si;
 struct kernel_ipmi_msg msg;

 si.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
 si.channel = IPMI_BMC_CHANNEL;
 si.lun = 0;

 msg.netfn = IPMI_NETFN_APP_REQUEST;
 msg.cmd = IPMI_GET_DEVICE_ID_CMD;
 msg.data = NULL;
 msg.data_len = 0;

 return i_ipmi_request(NULL,
         intf,
         (struct ipmi_addr *) &si,
         0,
         &msg,
         intf,
         NULL,
         NULL,
         0,
         intf->addrinfo[0].address,
         intf->addrinfo[0].lun,
         -1, 0);
}

static int __get_device_id(struct ipmi_smi *intf, struct bmc_device *bmc)
{
 int rv;
 unsigned int retry_count = 0;

 intf->null_user_handler = bmc_device_id_handler;

retry:
 bmc->cc = 0;
 bmc->dyn_id_set = 2;

 rv = send_get_device_id_cmd(intf);
 if (rv)
  goto out_reset_handler;

 wait_event(intf->waitq, bmc->dyn_id_set != 2);

 if (!bmc->dyn_id_set) {
  if (bmc->cc != IPMI_CC_NO_ERROR &&
      ++retry_count <= GET_DEVICE_ID_MAX_RETRY) {
   msleep(500);
   dev_warn(intf->si_dev,
       "BMC returned 0x%2.2x, retry get bmc device id\n",
       bmc->cc);
   goto retry;
  }

  rv = -EIO; /* Something went wrong in the fetch. */
 }

 /* dyn_id_set makes the id data available. */
 smp_rmb();

out_reset_handler:
 intf->null_user_handler = NULL;

 return rv;
}

/*
 * Fetch the device id for the bmc/interface.  You must pass in either
 * bmc or intf, this code will get the other one.  If the data has
 * been recently fetched, this will just use the cached data.  Otherwise
 * it will run a new fetch.
 *
--> --------------------

--> maximum size reached

--> --------------------