2 * acpi_ipmi.c - ACPI IPMI opregion
4 * Copyright (C) 2010, 2013 Intel Corporation
5 * Author: Zhao Yakui <yakui.zhao@intel.com>
6 * Lv Zheng <lv.zheng@intel.com>
8 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or (at
13 * your option) any later version.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
24 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
27 #include <linux/module.h>
28 #include <linux/acpi.h>
29 #include <linux/ipmi.h>
30 #include <linux/spinlock.h>
32 MODULE_AUTHOR("Zhao Yakui");
33 MODULE_DESCRIPTION("ACPI IPMI Opregion driver");
34 MODULE_LICENSE("GPL");
37 #define ACPI_IPMI_OK 0
38 #define ACPI_IPMI_TIMEOUT 0x10
39 #define ACPI_IPMI_UNKNOWN 0x07
40 /* the IPMI timeout is 5s */
41 #define IPMI_TIMEOUT (5000)
42 #define ACPI_IPMI_MAX_MSG_LENGTH 64
44 struct acpi_ipmi_device {
45 /* the device list attached to driver_data.ipmi_devices */
46 struct list_head head;
47 /* the IPMI request message list */
48 struct list_head tx_msg_list;
49 spinlock_t tx_msg_lock;
52 ipmi_user_t user_interface;
53 int ipmi_ifnum; /* IPMI interface number */
59 struct ipmi_driver_data {
60 struct list_head ipmi_devices;
61 struct ipmi_smi_watcher bmc_events;
62 struct ipmi_user_hndl ipmi_hndlrs;
63 struct mutex ipmi_lock;
65 * NOTE: IPMI System Interface Selection
66 * There is no system interface specified by the IPMI operation
67 * region access. We try to select one system interface with ACPI
68 * handle set. IPMI messages passed from the ACPI codes are sent
69 * to this selected global IPMI system interface.
71 struct acpi_ipmi_device *selected_smi;
74 struct acpi_ipmi_msg {
75 struct list_head head;
77 * General speaking the addr type should be SI_ADDR_TYPE. And
78 * the addr channel should be BMC.
79 * In fact it can also be IPMB type. But we will have to
80 * parse it from the Netfn command buffer. It is so complex
83 struct ipmi_addr addr;
85 /* it is used to track whether the IPMI message is finished */
86 struct completion tx_complete;
87 struct kernel_ipmi_msg tx_message;
89 /* tx/rx data . And copy it from/to ACPI object buffer */
90 u8 data[ACPI_IPMI_MAX_MSG_LENGTH];
92 struct acpi_ipmi_device *device;
96 /* IPMI request/response buffer per ACPI 4.0, sec 5.5.2.4.3.2 */
97 struct acpi_ipmi_buffer {
100 u8 data[ACPI_IPMI_MAX_MSG_LENGTH];
103 static void ipmi_register_bmc(int iface, struct device *dev);
104 static void ipmi_bmc_gone(int iface);
105 static void ipmi_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data);
107 static struct ipmi_driver_data driver_data = {
108 .ipmi_devices = LIST_HEAD_INIT(driver_data.ipmi_devices),
110 .owner = THIS_MODULE,
111 .new_smi = ipmi_register_bmc,
112 .smi_gone = ipmi_bmc_gone,
115 .ipmi_recv_hndl = ipmi_msg_handler,
117 .ipmi_lock = __MUTEX_INITIALIZER(driver_data.ipmi_lock)
120 static struct acpi_ipmi_device *
121 ipmi_dev_alloc(int iface, struct device *dev, acpi_handle handle)
123 struct acpi_ipmi_device *ipmi_device;
127 ipmi_device = kzalloc(sizeof(*ipmi_device), GFP_KERNEL);
131 kref_init(&ipmi_device->kref);
132 INIT_LIST_HEAD(&ipmi_device->head);
133 INIT_LIST_HEAD(&ipmi_device->tx_msg_list);
134 spin_lock_init(&ipmi_device->tx_msg_lock);
136 ipmi_device->handle = handle;
137 ipmi_device->dev = get_device(dev);
138 ipmi_device->ipmi_ifnum = iface;
140 err = ipmi_create_user(iface, &driver_data.ipmi_hndlrs,
147 ipmi_device->user_interface = user;
152 static void ipmi_dev_release(struct acpi_ipmi_device *ipmi_device)
154 ipmi_destroy_user(ipmi_device->user_interface);
155 put_device(ipmi_device->dev);
159 static void ipmi_dev_release_kref(struct kref *kref)
161 struct acpi_ipmi_device *ipmi =
162 container_of(kref, struct acpi_ipmi_device, kref);
164 ipmi_dev_release(ipmi);
167 static void __ipmi_dev_kill(struct acpi_ipmi_device *ipmi_device)
169 list_del(&ipmi_device->head);
170 if (driver_data.selected_smi == ipmi_device)
171 driver_data.selected_smi = NULL;
173 * Always setting dead flag after deleting from the list or
174 * list_for_each_entry() codes must get changed.
176 ipmi_device->dead = true;
179 static struct acpi_ipmi_device *acpi_ipmi_dev_get(void)
181 struct acpi_ipmi_device *ipmi_device = NULL;
183 mutex_lock(&driver_data.ipmi_lock);
184 if (driver_data.selected_smi) {
185 ipmi_device = driver_data.selected_smi;
186 kref_get(&ipmi_device->kref);
188 mutex_unlock(&driver_data.ipmi_lock);
193 static void acpi_ipmi_dev_put(struct acpi_ipmi_device *ipmi_device)
195 kref_put(&ipmi_device->kref, ipmi_dev_release_kref);
198 static struct acpi_ipmi_msg *ipmi_msg_alloc(void)
200 struct acpi_ipmi_device *ipmi;
201 struct acpi_ipmi_msg *ipmi_msg;
203 ipmi = acpi_ipmi_dev_get();
206 ipmi_msg = kzalloc(sizeof(struct acpi_ipmi_msg), GFP_KERNEL);
208 acpi_ipmi_dev_put(ipmi);
211 kref_init(&ipmi_msg->kref);
212 init_completion(&ipmi_msg->tx_complete);
213 INIT_LIST_HEAD(&ipmi_msg->head);
214 ipmi_msg->device = ipmi;
215 ipmi_msg->msg_done = ACPI_IPMI_UNKNOWN;
219 static void ipmi_msg_release(struct acpi_ipmi_msg *tx_msg)
221 acpi_ipmi_dev_put(tx_msg->device);
225 static void ipmi_msg_release_kref(struct kref *kref)
227 struct acpi_ipmi_msg *tx_msg =
228 container_of(kref, struct acpi_ipmi_msg, kref);
230 ipmi_msg_release(tx_msg);
233 static struct acpi_ipmi_msg *acpi_ipmi_msg_get(struct acpi_ipmi_msg *tx_msg)
235 kref_get(&tx_msg->kref);
240 static void acpi_ipmi_msg_put(struct acpi_ipmi_msg *tx_msg)
242 kref_put(&tx_msg->kref, ipmi_msg_release_kref);
245 #define IPMI_OP_RGN_NETFN(offset) ((offset >> 8) & 0xff)
246 #define IPMI_OP_RGN_CMD(offset) (offset & 0xff)
247 static int acpi_format_ipmi_request(struct acpi_ipmi_msg *tx_msg,
248 acpi_physical_address address,
251 struct kernel_ipmi_msg *msg;
252 struct acpi_ipmi_buffer *buffer;
253 struct acpi_ipmi_device *device;
256 msg = &tx_msg->tx_message;
258 * IPMI network function and command are encoded in the address
259 * within the IPMI OpRegion; see ACPI 4.0, sec 5.5.2.4.3.
261 msg->netfn = IPMI_OP_RGN_NETFN(address);
262 msg->cmd = IPMI_OP_RGN_CMD(address);
263 msg->data = tx_msg->data;
265 * value is the parameter passed by the IPMI opregion space handler.
266 * It points to the IPMI request message buffer
268 buffer = (struct acpi_ipmi_buffer *)value;
269 /* copy the tx message data */
270 if (buffer->length > ACPI_IPMI_MAX_MSG_LENGTH) {
271 dev_WARN_ONCE(tx_msg->device->dev, true,
272 "Unexpected request (msg len %d).\n",
276 msg->data_len = buffer->length;
277 memcpy(tx_msg->data, buffer->data, msg->data_len);
279 * now the default type is SYSTEM_INTERFACE and channel type is BMC.
280 * If the netfn is APP_REQUEST and the cmd is SEND_MESSAGE,
281 * the addr type should be changed to IPMB. Then we will have to parse
282 * the IPMI request message buffer to get the IPMB address.
283 * If so, please fix me.
285 tx_msg->addr.addr_type = IPMI_SYSTEM_INTERFACE_ADDR_TYPE;
286 tx_msg->addr.channel = IPMI_BMC_CHANNEL;
287 tx_msg->addr.data[0] = 0;
290 device = tx_msg->device;
291 spin_lock_irqsave(&device->tx_msg_lock, flags);
292 device->curr_msgid++;
293 tx_msg->tx_msgid = device->curr_msgid;
294 spin_unlock_irqrestore(&device->tx_msg_lock, flags);
298 static void acpi_format_ipmi_response(struct acpi_ipmi_msg *msg,
301 struct acpi_ipmi_buffer *buffer;
304 * value is also used as output parameter. It represents the response
305 * IPMI message returned by IPMI command.
307 buffer = (struct acpi_ipmi_buffer *)value;
309 * If the flag of msg_done is not set, it means that the IPMI command is
310 * not executed correctly.
312 buffer->status = msg->msg_done;
313 if (msg->msg_done != ACPI_IPMI_OK)
316 * If the IPMI response message is obtained correctly, the status code
317 * will be ACPI_IPMI_OK
319 buffer->length = msg->rx_len;
320 memcpy(buffer->data, msg->data, msg->rx_len);
323 static void ipmi_flush_tx_msg(struct acpi_ipmi_device *ipmi)
325 struct acpi_ipmi_msg *tx_msg;
329 * NOTE: On-going ipmi_recv_msg
330 * ipmi_msg_handler() may still be invoked by ipmi_si after
331 * flushing. But it is safe to do a fast flushing on module_exit()
332 * without waiting for all ipmi_recv_msg(s) to complete from
333 * ipmi_msg_handler() as it is ensured by ipmi_si that all
334 * ipmi_recv_msg(s) are freed after invoking ipmi_destroy_user().
336 spin_lock_irqsave(&ipmi->tx_msg_lock, flags);
337 while (!list_empty(&ipmi->tx_msg_list)) {
338 tx_msg = list_first_entry(&ipmi->tx_msg_list,
339 struct acpi_ipmi_msg,
341 list_del(&tx_msg->head);
342 spin_unlock_irqrestore(&ipmi->tx_msg_lock, flags);
344 /* wake up the sleep thread on the Tx msg */
345 complete(&tx_msg->tx_complete);
346 acpi_ipmi_msg_put(tx_msg);
347 spin_lock_irqsave(&ipmi->tx_msg_lock, flags);
349 spin_unlock_irqrestore(&ipmi->tx_msg_lock, flags);
352 static void ipmi_cancel_tx_msg(struct acpi_ipmi_device *ipmi,
353 struct acpi_ipmi_msg *msg)
355 struct acpi_ipmi_msg *tx_msg, *temp;
356 bool msg_found = false;
359 spin_lock_irqsave(&ipmi->tx_msg_lock, flags);
360 list_for_each_entry_safe(tx_msg, temp, &ipmi->tx_msg_list, head) {
363 list_del(&tx_msg->head);
367 spin_unlock_irqrestore(&ipmi->tx_msg_lock, flags);
370 acpi_ipmi_msg_put(tx_msg);
373 static void ipmi_msg_handler(struct ipmi_recv_msg *msg, void *user_msg_data)
375 struct acpi_ipmi_device *ipmi_device = user_msg_data;
376 bool msg_found = false;
377 struct acpi_ipmi_msg *tx_msg, *temp;
378 struct device *dev = ipmi_device->dev;
381 if (msg->user != ipmi_device->user_interface) {
382 dev_warn(dev, "Unexpected response is returned. "
383 "returned user %p, expected user %p\n",
384 msg->user, ipmi_device->user_interface);
387 spin_lock_irqsave(&ipmi_device->tx_msg_lock, flags);
388 list_for_each_entry_safe(tx_msg, temp, &ipmi_device->tx_msg_list, head) {
389 if (msg->msgid == tx_msg->tx_msgid) {
391 list_del(&tx_msg->head);
395 spin_unlock_irqrestore(&ipmi_device->tx_msg_lock, flags);
398 dev_warn(dev, "Unexpected response (msg id %ld) is "
399 "returned.\n", msg->msgid);
403 /* copy the response data to Rx_data buffer */
404 if (msg->msg.data_len > ACPI_IPMI_MAX_MSG_LENGTH) {
405 dev_WARN_ONCE(dev, true,
406 "Unexpected response (msg len %d).\n",
410 /* response msg is an error msg */
411 msg->recv_type = IPMI_RESPONSE_RECV_TYPE;
412 if (msg->recv_type == IPMI_RESPONSE_RECV_TYPE &&
413 msg->msg.data_len == 1) {
414 if (msg->msg.data[0] == IPMI_TIMEOUT_COMPLETION_CODE) {
415 dev_WARN_ONCE(dev, true,
416 "Unexpected response (timeout).\n");
417 tx_msg->msg_done = ACPI_IPMI_TIMEOUT;
421 tx_msg->rx_len = msg->msg.data_len;
422 memcpy(tx_msg->data, msg->msg.data, tx_msg->rx_len);
423 tx_msg->msg_done = ACPI_IPMI_OK;
425 complete(&tx_msg->tx_complete);
426 acpi_ipmi_msg_put(tx_msg);
428 ipmi_free_recv_msg(msg);
431 static void ipmi_register_bmc(int iface, struct device *dev)
433 struct acpi_ipmi_device *ipmi_device, *temp;
435 struct ipmi_smi_info smi_data;
438 err = ipmi_get_smi_info(iface, &smi_data);
443 if (smi_data.addr_src != SI_ACPI)
445 handle = smi_data.addr_info.acpi_info.acpi_handle;
449 ipmi_device = ipmi_dev_alloc(iface, smi_data.dev, handle);
451 dev_warn(smi_data.dev, "Can't create IPMI user interface\n");
455 mutex_lock(&driver_data.ipmi_lock);
456 list_for_each_entry(temp, &driver_data.ipmi_devices, head) {
458 * if the corresponding ACPI handle is already added
459 * to the device list, don't add it again.
461 if (temp->handle == handle)
465 if (!driver_data.selected_smi)
466 driver_data.selected_smi = ipmi_device;
467 list_add_tail(&ipmi_device->head, &driver_data.ipmi_devices);
468 mutex_unlock(&driver_data.ipmi_lock);
469 put_device(smi_data.dev);
473 mutex_unlock(&driver_data.ipmi_lock);
474 ipmi_dev_release(ipmi_device);
476 put_device(smi_data.dev);
480 static void ipmi_bmc_gone(int iface)
482 struct acpi_ipmi_device *ipmi_device, *temp;
483 bool dev_found = false;
485 mutex_lock(&driver_data.ipmi_lock);
486 list_for_each_entry_safe(ipmi_device, temp,
487 &driver_data.ipmi_devices, head) {
488 if (ipmi_device->ipmi_ifnum != iface) {
490 __ipmi_dev_kill(ipmi_device);
494 if (!driver_data.selected_smi)
495 driver_data.selected_smi = list_first_entry_or_null(
496 &driver_data.ipmi_devices,
497 struct acpi_ipmi_device, head);
498 mutex_unlock(&driver_data.ipmi_lock);
500 ipmi_flush_tx_msg(ipmi_device);
501 acpi_ipmi_dev_put(ipmi_device);
504 /* --------------------------------------------------------------------------
505 * Address Space Management
506 * -------------------------------------------------------------------------- */
508 * This is the IPMI opregion space handler.
509 * @function: indicates the read/write. In fact as the IPMI message is driven
510 * by command, only write is meaningful.
511 * @address: This contains the netfn/command of IPMI request message.
513 * @value : it is an in/out parameter. It points to the IPMI message buffer.
514 * Before the IPMI message is sent, it represents the actual request
515 * IPMI message. After the IPMI message is finished, it represents
516 * the response IPMI message returned by IPMI command.
517 * @handler_context: IPMI device context.
521 acpi_ipmi_space_handler(u32 function, acpi_physical_address address,
522 u32 bits, acpi_integer *value,
523 void *handler_context, void *region_context)
525 struct acpi_ipmi_msg *tx_msg;
526 struct acpi_ipmi_device *ipmi_device;
531 * IPMI opregion message.
532 * IPMI message is firstly written to the BMC and system software
533 * can get the respsonse. So it is unmeaningful for the read access
536 if ((function & ACPI_IO_MASK) == ACPI_READ)
539 tx_msg = ipmi_msg_alloc();
543 ipmi_device = tx_msg->device;
545 if (acpi_format_ipmi_request(tx_msg, address, value) != 0) {
546 ipmi_msg_release(tx_msg);
549 acpi_ipmi_msg_get(tx_msg);
550 mutex_lock(&driver_data.ipmi_lock);
551 /* Do not add a tx_msg that can not be flushed. */
552 if (ipmi_device->dead) {
553 mutex_unlock(&driver_data.ipmi_lock);
554 ipmi_msg_release(tx_msg);
557 spin_lock_irqsave(&ipmi_device->tx_msg_lock, flags);
558 list_add_tail(&tx_msg->head, &ipmi_device->tx_msg_list);
559 spin_unlock_irqrestore(&ipmi_device->tx_msg_lock, flags);
560 mutex_unlock(&driver_data.ipmi_lock);
561 err = ipmi_request_settime(ipmi_device->user_interface,
565 NULL, 0, 0, IPMI_TIMEOUT);
570 wait_for_completion(&tx_msg->tx_complete);
571 acpi_format_ipmi_response(tx_msg, value);
575 ipmi_cancel_tx_msg(ipmi_device, tx_msg);
576 acpi_ipmi_msg_put(tx_msg);
580 static int __init acpi_ipmi_init(void)
588 status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT,
589 ACPI_ADR_SPACE_IPMI, &acpi_ipmi_space_handler,
591 if (ACPI_FAILURE(status)) {
592 pr_warn("Can't register IPMI opregion space handle\n");
595 result = ipmi_smi_watcher_register(&driver_data.bmc_events);
597 pr_err("Can't register IPMI system interface watcher\n");
602 static void __exit acpi_ipmi_exit(void)
604 struct acpi_ipmi_device *ipmi_device;
609 ipmi_smi_watcher_unregister(&driver_data.bmc_events);
612 * When one smi_watcher is unregistered, it is only deleted
613 * from the smi_watcher list. But the smi_gone callback function
614 * is not called. So explicitly uninstall the ACPI IPMI oregion
615 * handler and free it.
617 mutex_lock(&driver_data.ipmi_lock);
618 while (!list_empty(&driver_data.ipmi_devices)) {
619 ipmi_device = list_first_entry(&driver_data.ipmi_devices,
620 struct acpi_ipmi_device,
622 __ipmi_dev_kill(ipmi_device);
623 mutex_unlock(&driver_data.ipmi_lock);
625 ipmi_flush_tx_msg(ipmi_device);
626 acpi_ipmi_dev_put(ipmi_device);
628 mutex_lock(&driver_data.ipmi_lock);
630 mutex_unlock(&driver_data.ipmi_lock);
631 acpi_remove_address_space_handler(ACPI_ROOT_OBJECT,
632 ACPI_ADR_SPACE_IPMI, &acpi_ipmi_space_handler);
635 module_init(acpi_ipmi_init);
636 module_exit(acpi_ipmi_exit);