ACPI: C-States: accounting of sleep states
[linux-2.6/mini2440.git] / drivers / firmware / dell_rbu.c
blobfdb8b042e64d121f3e4a9be60719efc25cf17f0c
1 /*
2 * dell_rbu.c
3 * Bios Update driver for Dell systems
4 * Author: Dell Inc
5 * Abhay Salunke <abhay_salunke@dell.com>
7 * Copyright (C) 2005 Dell Inc.
9 * Remote BIOS Update (rbu) driver is used for updating DELL BIOS by
10 * creating entries in the /sys file systems on Linux 2.6 and higher
11 * kernels. The driver supports two mechanism to update the BIOS namely
12 * contiguous and packetized. Both these methods still require having some
13 * application to set the CMOS bit indicating the BIOS to update itself
14 * after a reboot.
16 * Contiguous method:
17 * This driver writes the incoming data in a monolithic image by allocating
18 * contiguous physical pages large enough to accommodate the incoming BIOS
19 * image size.
21 * Packetized method:
22 * The driver writes the incoming packet image by allocating a new packet
23 * on every time the packet data is written. This driver requires an
24 * application to break the BIOS image in to fixed sized packet chunks.
26 * See Documentation/dell_rbu.txt for more info.
28 * This program is free software; you can redistribute it and/or modify
29 * it under the terms of the GNU General Public License v2.0 as published by
30 * the Free Software Foundation
32 * This program is distributed in the hope that it will be useful,
33 * but WITHOUT ANY WARRANTY; without even the implied warranty of
34 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
35 * GNU General Public License for more details.
37 #include <linux/config.h>
38 #include <linux/init.h>
39 #include <linux/module.h>
40 #include <linux/string.h>
41 #include <linux/errno.h>
42 #include <linux/blkdev.h>
43 #include <linux/platform_device.h>
44 #include <linux/spinlock.h>
45 #include <linux/moduleparam.h>
46 #include <linux/firmware.h>
47 #include <linux/dma-mapping.h>
49 MODULE_AUTHOR("Abhay Salunke <abhay_salunke@dell.com>");
50 MODULE_DESCRIPTION("Driver for updating BIOS image on DELL systems");
51 MODULE_LICENSE("GPL");
52 MODULE_VERSION("3.2");
54 #define BIOS_SCAN_LIMIT 0xffffffff
55 #define MAX_IMAGE_LENGTH 16
56 static struct _rbu_data {
57 void *image_update_buffer;
58 unsigned long image_update_buffer_size;
59 unsigned long bios_image_size;
60 int image_update_ordernum;
61 int dma_alloc;
62 spinlock_t lock;
63 unsigned long packet_read_count;
64 unsigned long num_packets;
65 unsigned long packetsize;
66 unsigned long imagesize;
67 int entry_created;
68 } rbu_data;
70 static char image_type[MAX_IMAGE_LENGTH + 1] = "mono";
71 module_param_string(image_type, image_type, sizeof (image_type), 0);
72 MODULE_PARM_DESC(image_type,
73 "BIOS image type. choose- mono or packet or init");
75 static unsigned long allocation_floor = 0x100000;
76 module_param(allocation_floor, ulong, 0644);
77 MODULE_PARM_DESC(allocation_floor,
78 "Minimum address for allocations when using Packet mode");
80 struct packet_data {
81 struct list_head list;
82 size_t length;
83 void *data;
84 int ordernum;
87 static struct packet_data packet_data_head;
89 static struct platform_device *rbu_device;
90 static int context;
91 static dma_addr_t dell_rbu_dmaaddr;
93 static void init_packet_head(void)
95 INIT_LIST_HEAD(&packet_data_head.list);
96 rbu_data.packet_read_count = 0;
97 rbu_data.num_packets = 0;
98 rbu_data.packetsize = 0;
99 rbu_data.imagesize = 0;
102 static int create_packet(void *data, size_t length)
104 struct packet_data *newpacket;
105 int ordernum = 0;
106 int retval = 0;
107 unsigned int packet_array_size = 0;
108 void **invalid_addr_packet_array = NULL;
109 void *packet_data_temp_buf = NULL;
110 unsigned int idx = 0;
112 pr_debug("create_packet: entry \n");
114 if (!rbu_data.packetsize) {
115 pr_debug("create_packet: packetsize not specified\n");
116 retval = -EINVAL;
117 goto out_noalloc;
120 spin_unlock(&rbu_data.lock);
122 newpacket = kzalloc(sizeof (struct packet_data), GFP_KERNEL);
124 if (!newpacket) {
125 printk(KERN_WARNING
126 "dell_rbu:%s: failed to allocate new "
127 "packet\n", __FUNCTION__);
128 retval = -ENOMEM;
129 spin_lock(&rbu_data.lock);
130 goto out_noalloc;
133 ordernum = get_order(length);
136 * BIOS errata mean we cannot allocate packets below 1MB or they will
137 * be overwritten by BIOS.
139 * array to temporarily hold packets
140 * that are below the allocation floor
142 * NOTE: very simplistic because we only need the floor to be at 1MB
143 * due to BIOS errata. This shouldn't be used for higher floors
144 * or you will run out of mem trying to allocate the array.
146 packet_array_size = max(
147 (unsigned int)(allocation_floor / rbu_data.packetsize),
148 (unsigned int)1);
149 invalid_addr_packet_array = kzalloc(packet_array_size * sizeof(void*),
150 GFP_KERNEL);
152 if (!invalid_addr_packet_array) {
153 printk(KERN_WARNING
154 "dell_rbu:%s: failed to allocate "
155 "invalid_addr_packet_array \n",
156 __FUNCTION__);
157 retval = -ENOMEM;
158 spin_lock(&rbu_data.lock);
159 goto out_alloc_packet;
162 while (!packet_data_temp_buf) {
163 packet_data_temp_buf = (unsigned char *)
164 __get_free_pages(GFP_KERNEL, ordernum);
165 if (!packet_data_temp_buf) {
166 printk(KERN_WARNING
167 "dell_rbu:%s: failed to allocate new "
168 "packet\n", __FUNCTION__);
169 retval = -ENOMEM;
170 spin_lock(&rbu_data.lock);
171 goto out_alloc_packet_array;
174 if ((unsigned long)virt_to_phys(packet_data_temp_buf)
175 < allocation_floor) {
176 pr_debug("packet 0x%lx below floor at 0x%lx.\n",
177 (unsigned long)virt_to_phys(
178 packet_data_temp_buf),
179 allocation_floor);
180 invalid_addr_packet_array[idx++] = packet_data_temp_buf;
181 packet_data_temp_buf = NULL;
184 spin_lock(&rbu_data.lock);
186 newpacket->data = packet_data_temp_buf;
188 pr_debug("create_packet: newpacket at physical addr %lx\n",
189 (unsigned long)virt_to_phys(newpacket->data));
191 /* packets may not have fixed size */
192 newpacket->length = length;
193 newpacket->ordernum = ordernum;
194 ++rbu_data.num_packets;
196 /* initialize the newly created packet headers */
197 INIT_LIST_HEAD(&newpacket->list);
198 list_add_tail(&newpacket->list, &packet_data_head.list);
200 memcpy(newpacket->data, data, length);
202 pr_debug("create_packet: exit \n");
204 out_alloc_packet_array:
205 /* always free packet array */
206 for (;idx>0;idx--) {
207 pr_debug("freeing unused packet below floor 0x%lx.\n",
208 (unsigned long)virt_to_phys(
209 invalid_addr_packet_array[idx-1]));
210 free_pages((unsigned long)invalid_addr_packet_array[idx-1],
211 ordernum);
213 kfree(invalid_addr_packet_array);
215 out_alloc_packet:
216 /* if error, free data */
217 if (retval)
218 kfree(newpacket);
220 out_noalloc:
221 return retval;
224 static int packetize_data(void *data, size_t length)
226 int rc = 0;
227 int done = 0;
228 int packet_length;
229 u8 *temp;
230 u8 *end = (u8 *) data + length;
231 pr_debug("packetize_data: data length %d\n", length);
232 if (!rbu_data.packetsize) {
233 printk(KERN_WARNING
234 "dell_rbu: packetsize not specified\n");
235 return -EIO;
238 temp = (u8 *) data;
240 /* packetize the hunk */
241 while (!done) {
242 if ((temp + rbu_data.packetsize) < end)
243 packet_length = rbu_data.packetsize;
244 else {
245 /* this is the last packet */
246 packet_length = end - temp;
247 done = 1;
250 if ((rc = create_packet(temp, packet_length)))
251 return rc;
253 pr_debug("%lu:%lu\n", temp, (end - temp));
254 temp += packet_length;
257 rbu_data.imagesize = length;
259 return rc;
262 static int do_packet_read(char *data, struct list_head *ptemp_list,
263 int length, int bytes_read, int *list_read_count)
265 void *ptemp_buf;
266 struct packet_data *newpacket = NULL;
267 int bytes_copied = 0;
268 int j = 0;
270 newpacket = list_entry(ptemp_list, struct packet_data, list);
271 *list_read_count += newpacket->length;
273 if (*list_read_count > bytes_read) {
274 /* point to the start of unread data */
275 j = newpacket->length - (*list_read_count - bytes_read);
276 /* point to the offset in the packet buffer */
277 ptemp_buf = (u8 *) newpacket->data + j;
279 * check if there is enough room in
280 * * the incoming buffer
282 if (length > (*list_read_count - bytes_read))
284 * copy what ever is there in this
285 * packet and move on
287 bytes_copied = (*list_read_count - bytes_read);
288 else
289 /* copy the remaining */
290 bytes_copied = length;
291 memcpy(data, ptemp_buf, bytes_copied);
293 return bytes_copied;
296 static int packet_read_list(char *data, size_t * pread_length)
298 struct list_head *ptemp_list;
299 int temp_count = 0;
300 int bytes_copied = 0;
301 int bytes_read = 0;
302 int remaining_bytes = 0;
303 char *pdest = data;
305 /* check if we have any packets */
306 if (0 == rbu_data.num_packets)
307 return -ENOMEM;
309 remaining_bytes = *pread_length;
310 bytes_read = rbu_data.packet_read_count;
312 ptemp_list = (&packet_data_head.list)->next;
313 while (!list_empty(ptemp_list)) {
314 bytes_copied = do_packet_read(pdest, ptemp_list,
315 remaining_bytes, bytes_read, &temp_count);
316 remaining_bytes -= bytes_copied;
317 bytes_read += bytes_copied;
318 pdest += bytes_copied;
320 * check if we reached end of buffer before reaching the
321 * last packet
323 if (remaining_bytes == 0)
324 break;
326 ptemp_list = ptemp_list->next;
328 /*finally set the bytes read */
329 *pread_length = bytes_read - rbu_data.packet_read_count;
330 rbu_data.packet_read_count = bytes_read;
331 return 0;
334 static void packet_empty_list(void)
336 struct list_head *ptemp_list;
337 struct list_head *pnext_list;
338 struct packet_data *newpacket;
340 ptemp_list = (&packet_data_head.list)->next;
341 while (!list_empty(ptemp_list)) {
342 newpacket =
343 list_entry(ptemp_list, struct packet_data, list);
344 pnext_list = ptemp_list->next;
345 list_del(ptemp_list);
346 ptemp_list = pnext_list;
348 * zero out the RBU packet memory before freeing
349 * to make sure there are no stale RBU packets left in memory
351 memset(newpacket->data, 0, rbu_data.packetsize);
352 free_pages((unsigned long) newpacket->data,
353 newpacket->ordernum);
354 kfree(newpacket);
356 rbu_data.packet_read_count = 0;
357 rbu_data.num_packets = 0;
358 rbu_data.imagesize = 0;
362 * img_update_free: Frees the buffer allocated for storing BIOS image
363 * Always called with lock held and returned with lock held
365 static void img_update_free(void)
367 if (!rbu_data.image_update_buffer)
368 return;
370 * zero out this buffer before freeing it to get rid of any stale
371 * BIOS image copied in memory.
373 memset(rbu_data.image_update_buffer, 0,
374 rbu_data.image_update_buffer_size);
375 if (rbu_data.dma_alloc == 1)
376 dma_free_coherent(NULL, rbu_data.bios_image_size,
377 rbu_data.image_update_buffer, dell_rbu_dmaaddr);
378 else
379 free_pages((unsigned long) rbu_data.image_update_buffer,
380 rbu_data.image_update_ordernum);
383 * Re-initialize the rbu_data variables after a free
385 rbu_data.image_update_ordernum = -1;
386 rbu_data.image_update_buffer = NULL;
387 rbu_data.image_update_buffer_size = 0;
388 rbu_data.bios_image_size = 0;
389 rbu_data.dma_alloc = 0;
393 * img_update_realloc: This function allocates the contiguous pages to
394 * accommodate the requested size of data. The memory address and size
395 * values are stored globally and on every call to this function the new
396 * size is checked to see if more data is required than the existing size.
397 * If true the previous memory is freed and new allocation is done to
398 * accommodate the new size. If the incoming size is less then than the
399 * already allocated size, then that memory is reused. This function is
400 * called with lock held and returns with lock held.
402 static int img_update_realloc(unsigned long size)
404 unsigned char *image_update_buffer = NULL;
405 unsigned long rc;
406 unsigned long img_buf_phys_addr;
407 int ordernum;
408 int dma_alloc = 0;
411 * check if the buffer of sufficient size has been
412 * already allocated
414 if (rbu_data.image_update_buffer_size >= size) {
416 * check for corruption
418 if ((size != 0) && (rbu_data.image_update_buffer == NULL)) {
419 printk(KERN_ERR "dell_rbu:%s: corruption "
420 "check failed\n", __FUNCTION__);
421 return -EINVAL;
424 * we have a valid pre-allocated buffer with
425 * sufficient size
427 return 0;
431 * free any previously allocated buffer
433 img_update_free();
435 spin_unlock(&rbu_data.lock);
437 ordernum = get_order(size);
438 image_update_buffer =
439 (unsigned char *) __get_free_pages(GFP_KERNEL, ordernum);
441 img_buf_phys_addr =
442 (unsigned long) virt_to_phys(image_update_buffer);
444 if (img_buf_phys_addr > BIOS_SCAN_LIMIT) {
445 free_pages((unsigned long) image_update_buffer, ordernum);
446 ordernum = -1;
447 image_update_buffer = dma_alloc_coherent(NULL, size,
448 &dell_rbu_dmaaddr, GFP_KERNEL);
449 dma_alloc = 1;
452 spin_lock(&rbu_data.lock);
454 if (image_update_buffer != NULL) {
455 rbu_data.image_update_buffer = image_update_buffer;
456 rbu_data.image_update_buffer_size = size;
457 rbu_data.bios_image_size =
458 rbu_data.image_update_buffer_size;
459 rbu_data.image_update_ordernum = ordernum;
460 rbu_data.dma_alloc = dma_alloc;
461 rc = 0;
462 } else {
463 pr_debug("Not enough memory for image update:"
464 "size = %ld\n", size);
465 rc = -ENOMEM;
468 return rc;
471 static ssize_t read_packet_data(char *buffer, loff_t pos, size_t count)
473 int retval;
474 size_t bytes_left;
475 size_t data_length;
476 char *ptempBuf = buffer;
478 /* check to see if we have something to return */
479 if (rbu_data.num_packets == 0) {
480 pr_debug("read_packet_data: no packets written\n");
481 retval = -ENOMEM;
482 goto read_rbu_data_exit;
485 if (pos > rbu_data.imagesize) {
486 retval = 0;
487 printk(KERN_WARNING "dell_rbu:read_packet_data: "
488 "data underrun\n");
489 goto read_rbu_data_exit;
492 bytes_left = rbu_data.imagesize - pos;
493 data_length = min(bytes_left, count);
495 if ((retval = packet_read_list(ptempBuf, &data_length)) < 0)
496 goto read_rbu_data_exit;
498 if ((pos + count) > rbu_data.imagesize) {
499 rbu_data.packet_read_count = 0;
500 /* this was the last copy */
501 retval = bytes_left;
502 } else
503 retval = count;
505 read_rbu_data_exit:
506 return retval;
509 static ssize_t read_rbu_mono_data(char *buffer, loff_t pos, size_t count)
511 unsigned char *ptemp = NULL;
512 size_t bytes_left = 0;
513 size_t data_length = 0;
514 ssize_t ret_count = 0;
516 /* check to see if we have something to return */
517 if ((rbu_data.image_update_buffer == NULL) ||
518 (rbu_data.bios_image_size == 0)) {
519 pr_debug("read_rbu_data_mono: image_update_buffer %p ,"
520 "bios_image_size %lu\n",
521 rbu_data.image_update_buffer,
522 rbu_data.bios_image_size);
523 ret_count = -ENOMEM;
524 goto read_rbu_data_exit;
527 if (pos > rbu_data.bios_image_size) {
528 ret_count = 0;
529 goto read_rbu_data_exit;
532 bytes_left = rbu_data.bios_image_size - pos;
533 data_length = min(bytes_left, count);
535 ptemp = rbu_data.image_update_buffer;
536 memcpy(buffer, (ptemp + pos), data_length);
538 if ((pos + count) > rbu_data.bios_image_size)
539 /* this was the last copy */
540 ret_count = bytes_left;
541 else
542 ret_count = count;
543 read_rbu_data_exit:
544 return ret_count;
547 static ssize_t read_rbu_data(struct kobject *kobj, char *buffer,
548 loff_t pos, size_t count)
550 ssize_t ret_count = 0;
552 spin_lock(&rbu_data.lock);
554 if (!strcmp(image_type, "mono"))
555 ret_count = read_rbu_mono_data(buffer, pos, count);
556 else if (!strcmp(image_type, "packet"))
557 ret_count = read_packet_data(buffer, pos, count);
558 else
559 pr_debug("read_rbu_data: invalid image type specified\n");
561 spin_unlock(&rbu_data.lock);
562 return ret_count;
565 static void callbackfn_rbu(const struct firmware *fw, void *context)
567 rbu_data.entry_created = 0;
569 if (!fw || !fw->size)
570 return;
572 spin_lock(&rbu_data.lock);
573 if (!strcmp(image_type, "mono")) {
574 if (!img_update_realloc(fw->size))
575 memcpy(rbu_data.image_update_buffer,
576 fw->data, fw->size);
577 } else if (!strcmp(image_type, "packet")) {
579 * we need to free previous packets if a
580 * new hunk of packets needs to be downloaded
582 packet_empty_list();
583 if (packetize_data(fw->data, fw->size))
584 /* Incase something goes wrong when we are
585 * in middle of packetizing the data, we
586 * need to free up whatever packets might
587 * have been created before we quit.
589 packet_empty_list();
590 } else
591 pr_debug("invalid image type specified.\n");
592 spin_unlock(&rbu_data.lock);
595 static ssize_t read_rbu_image_type(struct kobject *kobj, char *buffer,
596 loff_t pos, size_t count)
598 int size = 0;
599 if (!pos)
600 size = sprintf(buffer, "%s\n", image_type);
601 return size;
604 static ssize_t write_rbu_image_type(struct kobject *kobj, char *buffer,
605 loff_t pos, size_t count)
607 int rc = count;
608 int req_firm_rc = 0;
609 int i;
610 spin_lock(&rbu_data.lock);
612 * Find the first newline or space
614 for (i = 0; i < count; ++i)
615 if (buffer[i] == '\n' || buffer[i] == ' ') {
616 buffer[i] = '\0';
617 break;
619 if (i == count)
620 buffer[count] = '\0';
622 if (strstr(buffer, "mono"))
623 strcpy(image_type, "mono");
624 else if (strstr(buffer, "packet"))
625 strcpy(image_type, "packet");
626 else if (strstr(buffer, "init")) {
628 * If due to the user error the driver gets in a bad
629 * state where even though it is loaded , the
630 * /sys/class/firmware/dell_rbu entries are missing.
631 * to cover this situation the user can recreate entries
632 * by writing init to image_type.
634 if (!rbu_data.entry_created) {
635 spin_unlock(&rbu_data.lock);
636 req_firm_rc = request_firmware_nowait(THIS_MODULE,
637 FW_ACTION_NOHOTPLUG, "dell_rbu",
638 &rbu_device->dev, &context,
639 callbackfn_rbu);
640 if (req_firm_rc) {
641 printk(KERN_ERR
642 "dell_rbu:%s request_firmware_nowait"
643 " failed %d\n", __FUNCTION__, rc);
644 rc = -EIO;
645 } else
646 rbu_data.entry_created = 1;
648 spin_lock(&rbu_data.lock);
650 } else {
651 printk(KERN_WARNING "dell_rbu: image_type is invalid\n");
652 spin_unlock(&rbu_data.lock);
653 return -EINVAL;
656 /* we must free all previous allocations */
657 packet_empty_list();
658 img_update_free();
659 spin_unlock(&rbu_data.lock);
661 return rc;
664 static ssize_t read_rbu_packet_size(struct kobject *kobj, char *buffer,
665 loff_t pos, size_t count)
667 int size = 0;
668 if (!pos) {
669 spin_lock(&rbu_data.lock);
670 size = sprintf(buffer, "%lu\n", rbu_data.packetsize);
671 spin_unlock(&rbu_data.lock);
673 return size;
676 static ssize_t write_rbu_packet_size(struct kobject *kobj, char *buffer,
677 loff_t pos, size_t count)
679 unsigned long temp;
680 spin_lock(&rbu_data.lock);
681 packet_empty_list();
682 sscanf(buffer, "%lu", &temp);
683 if (temp < 0xffffffff)
684 rbu_data.packetsize = temp;
686 spin_unlock(&rbu_data.lock);
687 return count;
690 static struct bin_attribute rbu_data_attr = {
691 .attr = {.name = "data",.owner = THIS_MODULE,.mode = 0444},
692 .read = read_rbu_data,
695 static struct bin_attribute rbu_image_type_attr = {
696 .attr = {.name = "image_type",.owner = THIS_MODULE,.mode = 0644},
697 .read = read_rbu_image_type,
698 .write = write_rbu_image_type,
701 static struct bin_attribute rbu_packet_size_attr = {
702 .attr = {.name = "packet_size",.owner = THIS_MODULE,.mode = 0644},
703 .read = read_rbu_packet_size,
704 .write = write_rbu_packet_size,
707 static int __init dcdrbu_init(void)
709 int rc = 0;
710 spin_lock_init(&rbu_data.lock);
712 init_packet_head();
713 rbu_device =
714 platform_device_register_simple("dell_rbu", -1, NULL, 0);
715 if (!rbu_device) {
716 printk(KERN_ERR
717 "dell_rbu:%s:platform_device_register_simple "
718 "failed\n", __FUNCTION__);
719 return -EIO;
722 sysfs_create_bin_file(&rbu_device->dev.kobj, &rbu_data_attr);
723 sysfs_create_bin_file(&rbu_device->dev.kobj, &rbu_image_type_attr);
724 sysfs_create_bin_file(&rbu_device->dev.kobj,
725 &rbu_packet_size_attr);
727 rbu_data.entry_created = 0;
728 return rc;
732 static __exit void dcdrbu_exit(void)
734 spin_lock(&rbu_data.lock);
735 packet_empty_list();
736 img_update_free();
737 spin_unlock(&rbu_data.lock);
738 platform_device_unregister(rbu_device);
741 module_exit(dcdrbu_exit);
742 module_init(dcdrbu_init);
744 /* vim:noet:ts=8:sw=8