PNPACPI: remove EXPERIMENTAL dependency
[sfrench/cifs-2.6.git] / drivers / acpi / osl.c
1 /*
2  *  acpi_osl.c - OS-dependent functions ($Revision: 83 $)
3  *
4  *  Copyright (C) 2000       Andrew Henroid
5  *  Copyright (C) 2001, 2002 Andy Grover <andrew.grover@intel.com>
6  *  Copyright (C) 2001, 2002 Paul Diefenbaugh <paul.s.diefenbaugh@intel.com>
7  *
8  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9  *
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
13  *  (at your option) any later version.
14  *
15  *  This program is distributed in the hope that it will be useful,
16  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  *  GNU General Public License for more details.
19  *
20  *  You should have received a copy of the GNU General Public License
21  *  along with this program; if not, write to the Free Software
22  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
23  *
24  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
25  *
26  */
27
28 #include <linux/module.h>
29 #include <linux/kernel.h>
30 #include <linux/slab.h>
31 #include <linux/mm.h>
32 #include <linux/pci.h>
33 #include <linux/smp_lock.h>
34 #include <linux/interrupt.h>
35 #include <linux/kmod.h>
36 #include <linux/delay.h>
37 #include <linux/workqueue.h>
38 #include <linux/nmi.h>
39 #include <acpi/acpi.h>
40 #include <asm/io.h>
41 #include <acpi/acpi_bus.h>
42 #include <acpi/processor.h>
43 #include <asm/uaccess.h>
44
45 #include <linux/efi.h>
46
47 #define _COMPONENT              ACPI_OS_SERVICES
48 ACPI_MODULE_NAME("osl")
49 #define PREFIX          "ACPI: "
50 struct acpi_os_dpc {
51         acpi_osd_exec_callback function;
52         void *context;
53         struct work_struct work;
54 };
55
56 #ifdef CONFIG_ACPI_CUSTOM_DSDT
57 #include CONFIG_ACPI_CUSTOM_DSDT_FILE
58 #endif
59
60 #ifdef ENABLE_DEBUGGER
61 #include <linux/kdb.h>
62
63 /* stuff for debugger support */
64 int acpi_in_debugger;
65 EXPORT_SYMBOL(acpi_in_debugger);
66
67 extern char line_buf[80];
68 #endif                          /*ENABLE_DEBUGGER */
69
70 int acpi_specific_hotkey_enabled = TRUE;
71 EXPORT_SYMBOL(acpi_specific_hotkey_enabled);
72
73 static unsigned int acpi_irq_irq;
74 static acpi_osd_handler acpi_irq_handler;
75 static void *acpi_irq_context;
76 static struct workqueue_struct *kacpid_wq;
77
78 static void __init acpi_request_region (struct acpi_generic_address *addr,
79         unsigned int length, char *desc)
80 {
81         struct resource *res;
82
83         if (!addr->address || !length)
84                 return;
85
86         if (addr->address_space_id == ACPI_ADR_SPACE_SYSTEM_IO)
87                 res = request_region(addr->address, length, desc);
88         else if (addr->address_space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY)
89                 res = request_mem_region(addr->address, length, desc);
90 }
91
92 static int __init acpi_reserve_resources(void)
93 {
94         acpi_request_region(&acpi_fadt.xpm1a_evt_blk, acpi_fadt.pm1_evt_len,
95                 "ACPI PM1a_EVT_BLK");
96
97         acpi_request_region(&acpi_fadt.xpm1b_evt_blk, acpi_fadt.pm1_evt_len,
98                 "ACPI PM1b_EVT_BLK");
99
100         acpi_request_region(&acpi_fadt.xpm1a_cnt_blk, acpi_fadt.pm1_cnt_len,
101                 "ACPI PM1a_CNT_BLK");
102
103         acpi_request_region(&acpi_fadt.xpm1b_cnt_blk, acpi_fadt.pm1_cnt_len,
104                 "ACPI PM1b_CNT_BLK");
105
106         if (acpi_fadt.pm_tm_len == 4)
107                 acpi_request_region(&acpi_fadt.xpm_tmr_blk, 4, "ACPI PM_TMR");
108
109         acpi_request_region(&acpi_fadt.xpm2_cnt_blk, acpi_fadt.pm2_cnt_len,
110                 "ACPI PM2_CNT_BLK");
111
112         /* Length of GPE blocks must be a non-negative multiple of 2 */
113
114         if (!(acpi_fadt.gpe0_blk_len & 0x1))
115                 acpi_request_region(&acpi_fadt.xgpe0_blk,
116                                acpi_fadt.gpe0_blk_len, "ACPI GPE0_BLK");
117
118         if (!(acpi_fadt.gpe1_blk_len & 0x1))
119                 acpi_request_region(&acpi_fadt.xgpe1_blk,
120                                acpi_fadt.gpe1_blk_len, "ACPI GPE1_BLK");
121
122         return 0;
123 }
124 device_initcall(acpi_reserve_resources);
125
126 acpi_status acpi_os_initialize(void)
127 {
128         return AE_OK;
129 }
130
131 acpi_status acpi_os_initialize1(void)
132 {
133         /*
134          * Initialize PCI configuration space access, as we'll need to access
135          * it while walking the namespace (bus 0 and root bridges w/ _BBNs).
136          */
137         if (!raw_pci_ops) {
138                 printk(KERN_ERR PREFIX
139                        "Access to PCI configuration space unavailable\n");
140                 return AE_NULL_ENTRY;
141         }
142         kacpid_wq = create_singlethread_workqueue("kacpid");
143         BUG_ON(!kacpid_wq);
144
145         return AE_OK;
146 }
147
148 acpi_status acpi_os_terminate(void)
149 {
150         if (acpi_irq_handler) {
151                 acpi_os_remove_interrupt_handler(acpi_irq_irq,
152                                                  acpi_irq_handler);
153         }
154
155         destroy_workqueue(kacpid_wq);
156
157         return AE_OK;
158 }
159
160 void acpi_os_printf(const char *fmt, ...)
161 {
162         va_list args;
163         va_start(args, fmt);
164         acpi_os_vprintf(fmt, args);
165         va_end(args);
166 }
167
168 EXPORT_SYMBOL(acpi_os_printf);
169
170 void acpi_os_vprintf(const char *fmt, va_list args)
171 {
172         static char buffer[512];
173
174         vsprintf(buffer, fmt, args);
175
176 #ifdef ENABLE_DEBUGGER
177         if (acpi_in_debugger) {
178                 kdb_printf("%s", buffer);
179         } else {
180                 printk("%s", buffer);
181         }
182 #else
183         printk("%s", buffer);
184 #endif
185 }
186
187 acpi_status acpi_os_get_root_pointer(u32 flags, struct acpi_pointer *addr)
188 {
189         if (efi_enabled) {
190                 addr->pointer_type = ACPI_PHYSICAL_POINTER;
191                 if (efi.acpi20 != EFI_INVALID_TABLE_ADDR)
192                         addr->pointer.physical = efi.acpi20;
193                 else if (efi.acpi != EFI_INVALID_TABLE_ADDR)
194                         addr->pointer.physical = efi.acpi;
195                 else {
196                         printk(KERN_ERR PREFIX
197                                "System description tables not found\n");
198                         return AE_NOT_FOUND;
199                 }
200         } else {
201                 if (ACPI_FAILURE(acpi_find_root_pointer(flags, addr))) {
202                         printk(KERN_ERR PREFIX
203                                "System description tables not found\n");
204                         return AE_NOT_FOUND;
205                 }
206         }
207
208         return AE_OK;
209 }
210
211 acpi_status
212 acpi_os_map_memory(acpi_physical_address phys, acpi_size size,
213                    void __iomem ** virt)
214 {
215         if (phys > ULONG_MAX) {
216                 printk(KERN_ERR PREFIX "Cannot map memory that high\n");
217                 return AE_BAD_PARAMETER;
218         }
219         /*
220          * ioremap checks to ensure this is in reserved space
221          */
222         *virt = ioremap((unsigned long)phys, size);
223
224         if (!*virt)
225                 return AE_NO_MEMORY;
226
227         return AE_OK;
228 }
229 EXPORT_SYMBOL_GPL(acpi_os_map_memory);
230
231 void acpi_os_unmap_memory(void __iomem * virt, acpi_size size)
232 {
233         iounmap(virt);
234 }
235 EXPORT_SYMBOL_GPL(acpi_os_unmap_memory);
236
237 #ifdef ACPI_FUTURE_USAGE
238 acpi_status
239 acpi_os_get_physical_address(void *virt, acpi_physical_address * phys)
240 {
241         if (!phys || !virt)
242                 return AE_BAD_PARAMETER;
243
244         *phys = virt_to_phys(virt);
245
246         return AE_OK;
247 }
248 #endif
249
250 #define ACPI_MAX_OVERRIDE_LEN 100
251
252 static char acpi_os_name[ACPI_MAX_OVERRIDE_LEN];
253
254 acpi_status
255 acpi_os_predefined_override(const struct acpi_predefined_names *init_val,
256                             acpi_string * new_val)
257 {
258         if (!init_val || !new_val)
259                 return AE_BAD_PARAMETER;
260
261         *new_val = NULL;
262         if (!memcmp(init_val->name, "_OS_", 4) && strlen(acpi_os_name)) {
263                 printk(KERN_INFO PREFIX "Overriding _OS definition to '%s'\n",
264                        acpi_os_name);
265                 *new_val = acpi_os_name;
266         }
267
268         return AE_OK;
269 }
270
271 acpi_status
272 acpi_os_table_override(struct acpi_table_header * existing_table,
273                        struct acpi_table_header ** new_table)
274 {
275         if (!existing_table || !new_table)
276                 return AE_BAD_PARAMETER;
277
278 #ifdef CONFIG_ACPI_CUSTOM_DSDT
279         if (strncmp(existing_table->signature, "DSDT", 4) == 0)
280                 *new_table = (struct acpi_table_header *)AmlCode;
281         else
282                 *new_table = NULL;
283 #else
284         *new_table = NULL;
285 #endif
286         return AE_OK;
287 }
288
289 static irqreturn_t acpi_irq(int irq, void *dev_id)
290 {
291         return (*acpi_irq_handler) (acpi_irq_context) ? IRQ_HANDLED : IRQ_NONE;
292 }
293
294 acpi_status
295 acpi_os_install_interrupt_handler(u32 gsi, acpi_osd_handler handler,
296                                   void *context)
297 {
298         unsigned int irq;
299
300         /*
301          * Ignore the GSI from the core, and use the value in our copy of the
302          * FADT. It may not be the same if an interrupt source override exists
303          * for the SCI.
304          */
305         gsi = acpi_fadt.sci_int;
306         if (acpi_gsi_to_irq(gsi, &irq) < 0) {
307                 printk(KERN_ERR PREFIX "SCI (ACPI GSI %d) not registered\n",
308                        gsi);
309                 return AE_OK;
310         }
311
312         acpi_irq_handler = handler;
313         acpi_irq_context = context;
314         if (request_irq(irq, acpi_irq, IRQF_SHARED, "acpi", acpi_irq)) {
315                 printk(KERN_ERR PREFIX "SCI (IRQ%d) allocation failed\n", irq);
316                 return AE_NOT_ACQUIRED;
317         }
318         acpi_irq_irq = irq;
319
320         return AE_OK;
321 }
322
323 acpi_status acpi_os_remove_interrupt_handler(u32 irq, acpi_osd_handler handler)
324 {
325         if (irq) {
326                 free_irq(irq, acpi_irq);
327                 acpi_irq_handler = NULL;
328                 acpi_irq_irq = 0;
329         }
330
331         return AE_OK;
332 }
333
334 /*
335  * Running in interpreter thread context, safe to sleep
336  */
337
338 void acpi_os_sleep(acpi_integer ms)
339 {
340         schedule_timeout_interruptible(msecs_to_jiffies(ms));
341 }
342
343 EXPORT_SYMBOL(acpi_os_sleep);
344
345 void acpi_os_stall(u32 us)
346 {
347         while (us) {
348                 u32 delay = 1000;
349
350                 if (delay > us)
351                         delay = us;
352                 udelay(delay);
353                 touch_nmi_watchdog();
354                 us -= delay;
355         }
356 }
357
358 EXPORT_SYMBOL(acpi_os_stall);
359
360 /*
361  * Support ACPI 3.0 AML Timer operand
362  * Returns 64-bit free-running, monotonically increasing timer
363  * with 100ns granularity
364  */
365 u64 acpi_os_get_timer(void)
366 {
367         static u64 t;
368
369 #ifdef  CONFIG_HPET
370         /* TBD: use HPET if available */
371 #endif
372
373 #ifdef  CONFIG_X86_PM_TIMER
374         /* TBD: default to PM timer if HPET was not available */
375 #endif
376         if (!t)
377                 printk(KERN_ERR PREFIX "acpi_os_get_timer() TBD\n");
378
379         return ++t;
380 }
381
382 acpi_status acpi_os_read_port(acpi_io_address port, u32 * value, u32 width)
383 {
384         u32 dummy;
385
386         if (!value)
387                 value = &dummy;
388
389         switch (width) {
390         case 8:
391                 *(u8 *) value = inb(port);
392                 break;
393         case 16:
394                 *(u16 *) value = inw(port);
395                 break;
396         case 32:
397                 *(u32 *) value = inl(port);
398                 break;
399         default:
400                 BUG();
401         }
402
403         return AE_OK;
404 }
405
406 EXPORT_SYMBOL(acpi_os_read_port);
407
408 acpi_status acpi_os_write_port(acpi_io_address port, u32 value, u32 width)
409 {
410         switch (width) {
411         case 8:
412                 outb(value, port);
413                 break;
414         case 16:
415                 outw(value, port);
416                 break;
417         case 32:
418                 outl(value, port);
419                 break;
420         default:
421                 BUG();
422         }
423
424         return AE_OK;
425 }
426
427 EXPORT_SYMBOL(acpi_os_write_port);
428
429 acpi_status
430 acpi_os_read_memory(acpi_physical_address phys_addr, u32 * value, u32 width)
431 {
432         u32 dummy;
433         void __iomem *virt_addr;
434
435         virt_addr = ioremap(phys_addr, width);
436         if (!value)
437                 value = &dummy;
438
439         switch (width) {
440         case 8:
441                 *(u8 *) value = readb(virt_addr);
442                 break;
443         case 16:
444                 *(u16 *) value = readw(virt_addr);
445                 break;
446         case 32:
447                 *(u32 *) value = readl(virt_addr);
448                 break;
449         default:
450                 BUG();
451         }
452
453         iounmap(virt_addr);
454
455         return AE_OK;
456 }
457
458 acpi_status
459 acpi_os_write_memory(acpi_physical_address phys_addr, u32 value, u32 width)
460 {
461         void __iomem *virt_addr;
462
463         virt_addr = ioremap(phys_addr, width);
464
465         switch (width) {
466         case 8:
467                 writeb(value, virt_addr);
468                 break;
469         case 16:
470                 writew(value, virt_addr);
471                 break;
472         case 32:
473                 writel(value, virt_addr);
474                 break;
475         default:
476                 BUG();
477         }
478
479         iounmap(virt_addr);
480
481         return AE_OK;
482 }
483
484 acpi_status
485 acpi_os_read_pci_configuration(struct acpi_pci_id * pci_id, u32 reg,
486                                void *value, u32 width)
487 {
488         int result, size;
489
490         if (!value)
491                 return AE_BAD_PARAMETER;
492
493         switch (width) {
494         case 8:
495                 size = 1;
496                 break;
497         case 16:
498                 size = 2;
499                 break;
500         case 32:
501                 size = 4;
502                 break;
503         default:
504                 return AE_ERROR;
505         }
506
507         BUG_ON(!raw_pci_ops);
508
509         result = raw_pci_ops->read(pci_id->segment, pci_id->bus,
510                                    PCI_DEVFN(pci_id->device, pci_id->function),
511                                    reg, size, value);
512
513         return (result ? AE_ERROR : AE_OK);
514 }
515
516 EXPORT_SYMBOL(acpi_os_read_pci_configuration);
517
518 acpi_status
519 acpi_os_write_pci_configuration(struct acpi_pci_id * pci_id, u32 reg,
520                                 acpi_integer value, u32 width)
521 {
522         int result, size;
523
524         switch (width) {
525         case 8:
526                 size = 1;
527                 break;
528         case 16:
529                 size = 2;
530                 break;
531         case 32:
532                 size = 4;
533                 break;
534         default:
535                 return AE_ERROR;
536         }
537
538         BUG_ON(!raw_pci_ops);
539
540         result = raw_pci_ops->write(pci_id->segment, pci_id->bus,
541                                     PCI_DEVFN(pci_id->device, pci_id->function),
542                                     reg, size, value);
543
544         return (result ? AE_ERROR : AE_OK);
545 }
546
547 /* TODO: Change code to take advantage of driver model more */
548 static void acpi_os_derive_pci_id_2(acpi_handle rhandle,        /* upper bound  */
549                                     acpi_handle chandle,        /* current node */
550                                     struct acpi_pci_id **id,
551                                     int *is_bridge, u8 * bus_number)
552 {
553         acpi_handle handle;
554         struct acpi_pci_id *pci_id = *id;
555         acpi_status status;
556         unsigned long temp;
557         acpi_object_type type;
558         u8 tu8;
559
560         acpi_get_parent(chandle, &handle);
561         if (handle != rhandle) {
562                 acpi_os_derive_pci_id_2(rhandle, handle, &pci_id, is_bridge,
563                                         bus_number);
564
565                 status = acpi_get_type(handle, &type);
566                 if ((ACPI_FAILURE(status)) || (type != ACPI_TYPE_DEVICE))
567                         return;
568
569                 status =
570                     acpi_evaluate_integer(handle, METHOD_NAME__ADR, NULL,
571                                           &temp);
572                 if (ACPI_SUCCESS(status)) {
573                         pci_id->device = ACPI_HIWORD(ACPI_LODWORD(temp));
574                         pci_id->function = ACPI_LOWORD(ACPI_LODWORD(temp));
575
576                         if (*is_bridge)
577                                 pci_id->bus = *bus_number;
578
579                         /* any nicer way to get bus number of bridge ? */
580                         status =
581                             acpi_os_read_pci_configuration(pci_id, 0x0e, &tu8,
582                                                            8);
583                         if (ACPI_SUCCESS(status)
584                             && ((tu8 & 0x7f) == 1 || (tu8 & 0x7f) == 2)) {
585                                 status =
586                                     acpi_os_read_pci_configuration(pci_id, 0x18,
587                                                                    &tu8, 8);
588                                 if (!ACPI_SUCCESS(status)) {
589                                         /* Certainly broken...  FIX ME */
590                                         return;
591                                 }
592                                 *is_bridge = 1;
593                                 pci_id->bus = tu8;
594                                 status =
595                                     acpi_os_read_pci_configuration(pci_id, 0x19,
596                                                                    &tu8, 8);
597                                 if (ACPI_SUCCESS(status)) {
598                                         *bus_number = tu8;
599                                 }
600                         } else
601                                 *is_bridge = 0;
602                 }
603         }
604 }
605
606 void acpi_os_derive_pci_id(acpi_handle rhandle, /* upper bound  */
607                            acpi_handle chandle, /* current node */
608                            struct acpi_pci_id **id)
609 {
610         int is_bridge = 1;
611         u8 bus_number = (*id)->bus;
612
613         acpi_os_derive_pci_id_2(rhandle, chandle, id, &is_bridge, &bus_number);
614 }
615
616 static void acpi_os_execute_deferred(struct work_struct *work)
617 {
618         struct acpi_os_dpc *dpc = container_of(work, struct acpi_os_dpc, work);
619         if (!dpc) {
620                 printk(KERN_ERR PREFIX "Invalid (NULL) context\n");
621                 return;
622         }
623
624         dpc->function(dpc->context);
625
626         kfree(dpc);
627
628         return;
629 }
630
631 /*******************************************************************************
632  *
633  * FUNCTION:    acpi_os_execute
634  *
635  * PARAMETERS:  Type               - Type of the callback
636  *              Function           - Function to be executed
637  *              Context            - Function parameters
638  *
639  * RETURN:      Status
640  *
641  * DESCRIPTION: Depending on type, either queues function for deferred execution or
642  *              immediately executes function on a separate thread.
643  *
644  ******************************************************************************/
645
646 acpi_status acpi_os_execute(acpi_execute_type type,
647                             acpi_osd_exec_callback function, void *context)
648 {
649         acpi_status status = AE_OK;
650         struct acpi_os_dpc *dpc;
651
652         ACPI_FUNCTION_TRACE("os_queue_for_execution");
653
654         ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
655                           "Scheduling function [%p(%p)] for deferred execution.\n",
656                           function, context));
657
658         if (!function)
659                 return_ACPI_STATUS(AE_BAD_PARAMETER);
660
661         /*
662          * Allocate/initialize DPC structure.  Note that this memory will be
663          * freed by the callee.  The kernel handles the work_struct list  in a
664          * way that allows us to also free its memory inside the callee.
665          * Because we may want to schedule several tasks with different
666          * parameters we can't use the approach some kernel code uses of
667          * having a static work_struct.
668          */
669
670         dpc = kmalloc(sizeof(struct acpi_os_dpc), GFP_ATOMIC);
671         if (!dpc)
672                 return_ACPI_STATUS(AE_NO_MEMORY);
673
674         dpc->function = function;
675         dpc->context = context;
676
677         INIT_WORK(&dpc->work, acpi_os_execute_deferred);
678         if (!queue_work(kacpid_wq, &dpc->work)) {
679                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
680                                   "Call to queue_work() failed.\n"));
681                 kfree(dpc);
682                 status = AE_ERROR;
683         }
684
685         return_ACPI_STATUS(status);
686 }
687
688 EXPORT_SYMBOL(acpi_os_execute);
689
690 void acpi_os_wait_events_complete(void *context)
691 {
692         flush_workqueue(kacpid_wq);
693 }
694
695 EXPORT_SYMBOL(acpi_os_wait_events_complete);
696
697 /*
698  * Allocate the memory for a spinlock and initialize it.
699  */
700 acpi_status acpi_os_create_lock(acpi_spinlock * handle)
701 {
702         spin_lock_init(*handle);
703
704         return AE_OK;
705 }
706
707 /*
708  * Deallocate the memory for a spinlock.
709  */
710 void acpi_os_delete_lock(acpi_spinlock handle)
711 {
712         return;
713 }
714
715 acpi_status
716 acpi_os_create_semaphore(u32 max_units, u32 initial_units, acpi_handle * handle)
717 {
718         struct semaphore *sem = NULL;
719
720
721         sem = acpi_os_allocate(sizeof(struct semaphore));
722         if (!sem)
723                 return AE_NO_MEMORY;
724         memset(sem, 0, sizeof(struct semaphore));
725
726         sema_init(sem, initial_units);
727
728         *handle = (acpi_handle *) sem;
729
730         ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Creating semaphore[%p|%d].\n",
731                           *handle, initial_units));
732
733         return AE_OK;
734 }
735
736 EXPORT_SYMBOL(acpi_os_create_semaphore);
737
738 /*
739  * TODO: A better way to delete semaphores?  Linux doesn't have a
740  * 'delete_semaphore()' function -- may result in an invalid
741  * pointer dereference for non-synchronized consumers.  Should
742  * we at least check for blocked threads and signal/cancel them?
743  */
744
745 acpi_status acpi_os_delete_semaphore(acpi_handle handle)
746 {
747         struct semaphore *sem = (struct semaphore *)handle;
748
749
750         if (!sem)
751                 return AE_BAD_PARAMETER;
752
753         ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Deleting semaphore[%p].\n", handle));
754
755         kfree(sem);
756         sem = NULL;
757
758         return AE_OK;
759 }
760
761 EXPORT_SYMBOL(acpi_os_delete_semaphore);
762
763 /*
764  * TODO: The kernel doesn't have a 'down_timeout' function -- had to
765  * improvise.  The process is to sleep for one scheduler quantum
766  * until the semaphore becomes available.  Downside is that this
767  * may result in starvation for timeout-based waits when there's
768  * lots of semaphore activity.
769  *
770  * TODO: Support for units > 1?
771  */
772 acpi_status acpi_os_wait_semaphore(acpi_handle handle, u32 units, u16 timeout)
773 {
774         acpi_status status = AE_OK;
775         struct semaphore *sem = (struct semaphore *)handle;
776         int ret = 0;
777
778
779         if (!sem || (units < 1))
780                 return AE_BAD_PARAMETER;
781
782         if (units > 1)
783                 return AE_SUPPORT;
784
785         ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Waiting for semaphore[%p|%d|%d]\n",
786                           handle, units, timeout));
787
788         /*
789          * This can be called during resume with interrupts off.
790          * Like boot-time, we should be single threaded and will
791          * always get the lock if we try -- timeout or not.
792          * If this doesn't succeed, then we will oops courtesy of
793          * might_sleep() in down().
794          */
795         if (!down_trylock(sem))
796                 return AE_OK;
797
798         switch (timeout) {
799                 /*
800                  * No Wait:
801                  * --------
802                  * A zero timeout value indicates that we shouldn't wait - just
803                  * acquire the semaphore if available otherwise return AE_TIME
804                  * (a.k.a. 'would block').
805                  */
806         case 0:
807                 if (down_trylock(sem))
808                         status = AE_TIME;
809                 break;
810
811                 /*
812                  * Wait Indefinitely:
813                  * ------------------
814                  */
815         case ACPI_WAIT_FOREVER:
816                 down(sem);
817                 break;
818
819                 /*
820                  * Wait w/ Timeout:
821                  * ----------------
822                  */
823         default:
824                 // TODO: A better timeout algorithm?
825                 {
826                         int i = 0;
827                         static const int quantum_ms = 1000 / HZ;
828
829                         ret = down_trylock(sem);
830                         for (i = timeout; (i > 0 && ret != 0); i -= quantum_ms) {
831                                 schedule_timeout_interruptible(1);
832                                 ret = down_trylock(sem);
833                         }
834
835                         if (ret != 0)
836                                 status = AE_TIME;
837                 }
838                 break;
839         }
840
841         if (ACPI_FAILURE(status)) {
842                 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
843                                   "Failed to acquire semaphore[%p|%d|%d], %s",
844                                   handle, units, timeout,
845                                   acpi_format_exception(status)));
846         } else {
847                 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
848                                   "Acquired semaphore[%p|%d|%d]", handle,
849                                   units, timeout));
850         }
851
852         return status;
853 }
854
855 EXPORT_SYMBOL(acpi_os_wait_semaphore);
856
857 /*
858  * TODO: Support for units > 1?
859  */
860 acpi_status acpi_os_signal_semaphore(acpi_handle handle, u32 units)
861 {
862         struct semaphore *sem = (struct semaphore *)handle;
863
864
865         if (!sem || (units < 1))
866                 return AE_BAD_PARAMETER;
867
868         if (units > 1)
869                 return AE_SUPPORT;
870
871         ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "Signaling semaphore[%p|%d]\n", handle,
872                           units));
873
874         up(sem);
875
876         return AE_OK;
877 }
878
879 EXPORT_SYMBOL(acpi_os_signal_semaphore);
880
881 #ifdef ACPI_FUTURE_USAGE
882 u32 acpi_os_get_line(char *buffer)
883 {
884
885 #ifdef ENABLE_DEBUGGER
886         if (acpi_in_debugger) {
887                 u32 chars;
888
889                 kdb_read(buffer, sizeof(line_buf));
890
891                 /* remove the CR kdb includes */
892                 chars = strlen(buffer) - 1;
893                 buffer[chars] = '\0';
894         }
895 #endif
896
897         return 0;
898 }
899 #endif                          /*  ACPI_FUTURE_USAGE  */
900
901 /* Assumes no unreadable holes inbetween */
902 u8 acpi_os_readable(void *ptr, acpi_size len)
903 {
904 #if defined(__i386__) || defined(__x86_64__)
905         char tmp;
906         return !__get_user(tmp, (char __user *)ptr)
907             && !__get_user(tmp, (char __user *)ptr + len - 1);
908 #endif
909         return 1;
910 }
911
912 #ifdef ACPI_FUTURE_USAGE
913 u8 acpi_os_writable(void *ptr, acpi_size len)
914 {
915         /* could do dummy write (racy) or a kernel page table lookup.
916            The later may be difficult at early boot when kmap doesn't work yet. */
917         return 1;
918 }
919 #endif
920
921 acpi_status acpi_os_signal(u32 function, void *info)
922 {
923         switch (function) {
924         case ACPI_SIGNAL_FATAL:
925                 printk(KERN_ERR PREFIX "Fatal opcode executed\n");
926                 break;
927         case ACPI_SIGNAL_BREAKPOINT:
928                 /*
929                  * AML Breakpoint
930                  * ACPI spec. says to treat it as a NOP unless
931                  * you are debugging.  So if/when we integrate
932                  * AML debugger into the kernel debugger its
933                  * hook will go here.  But until then it is
934                  * not useful to print anything on breakpoints.
935                  */
936                 break;
937         default:
938                 break;
939         }
940
941         return AE_OK;
942 }
943
944 EXPORT_SYMBOL(acpi_os_signal);
945
946 static int __init acpi_os_name_setup(char *str)
947 {
948         char *p = acpi_os_name;
949         int count = ACPI_MAX_OVERRIDE_LEN - 1;
950
951         if (!str || !*str)
952                 return 0;
953
954         for (; count-- && str && *str; str++) {
955                 if (isalnum(*str) || *str == ' ' || *str == ':')
956                         *p++ = *str;
957                 else if (*str == '\'' || *str == '"')
958                         continue;
959                 else
960                         break;
961         }
962         *p = 0;
963
964         return 1;
965
966 }
967
968 __setup("acpi_os_name=", acpi_os_name_setup);
969
970 /*
971  * _OSI control
972  * empty string disables _OSI
973  * TBD additional string adds to _OSI
974  */
975 static int __init acpi_osi_setup(char *str)
976 {
977         if (str == NULL || *str == '\0') {
978                 printk(KERN_INFO PREFIX "_OSI method disabled\n");
979                 acpi_gbl_create_osi_method = FALSE;
980         } else {
981                 /* TBD */
982                 printk(KERN_ERR PREFIX "_OSI additional string ignored -- %s\n",
983                        str);
984         }
985
986         return 1;
987 }
988
989 __setup("acpi_osi=", acpi_osi_setup);
990
991 /* enable serialization to combat AE_ALREADY_EXISTS errors */
992 static int __init acpi_serialize_setup(char *str)
993 {
994         printk(KERN_INFO PREFIX "serialize enabled\n");
995
996         acpi_gbl_all_methods_serialized = TRUE;
997
998         return 1;
999 }
1000
1001 __setup("acpi_serialize", acpi_serialize_setup);
1002
1003 /*
1004  * Wake and Run-Time GPES are expected to be separate.
1005  * We disable wake-GPEs at run-time to prevent spurious
1006  * interrupts.
1007  *
1008  * However, if a system exists that shares Wake and
1009  * Run-time events on the same GPE this flag is available
1010  * to tell Linux to keep the wake-time GPEs enabled at run-time.
1011  */
1012 static int __init acpi_wake_gpes_always_on_setup(char *str)
1013 {
1014         printk(KERN_INFO PREFIX "wake GPEs not disabled\n");
1015
1016         acpi_gbl_leave_wake_gpes_disabled = FALSE;
1017
1018         return 1;
1019 }
1020
1021 __setup("acpi_wake_gpes_always_on", acpi_wake_gpes_always_on_setup);
1022
1023 static int __init acpi_hotkey_setup(char *str)
1024 {
1025         acpi_specific_hotkey_enabled = FALSE;
1026         return 1;
1027 }
1028
1029 __setup("acpi_generic_hotkey", acpi_hotkey_setup);
1030
1031 /*
1032  * max_cstate is defined in the base kernel so modules can
1033  * change it w/o depending on the state of the processor module.
1034  */
1035 unsigned int max_cstate = ACPI_PROCESSOR_MAX_POWER;
1036
1037 EXPORT_SYMBOL(max_cstate);
1038
1039 /*
1040  * Acquire a spinlock.
1041  *
1042  * handle is a pointer to the spinlock_t.
1043  */
1044
1045 acpi_cpu_flags acpi_os_acquire_lock(acpi_spinlock lockp)
1046 {
1047         acpi_cpu_flags flags;
1048         spin_lock_irqsave(lockp, flags);
1049         return flags;
1050 }
1051
1052 /*
1053  * Release a spinlock. See above.
1054  */
1055
1056 void acpi_os_release_lock(acpi_spinlock lockp, acpi_cpu_flags flags)
1057 {
1058         spin_unlock_irqrestore(lockp, flags);
1059 }
1060
1061 #ifndef ACPI_USE_LOCAL_CACHE
1062
1063 /*******************************************************************************
1064  *
1065  * FUNCTION:    acpi_os_create_cache
1066  *
1067  * PARAMETERS:  name      - Ascii name for the cache
1068  *              size      - Size of each cached object
1069  *              depth     - Maximum depth of the cache (in objects) <ignored>
1070  *              cache     - Where the new cache object is returned
1071  *
1072  * RETURN:      status
1073  *
1074  * DESCRIPTION: Create a cache object
1075  *
1076  ******************************************************************************/
1077
1078 acpi_status
1079 acpi_os_create_cache(char *name, u16 size, u16 depth, acpi_cache_t ** cache)
1080 {
1081         *cache = kmem_cache_create(name, size, 0, 0, NULL, NULL);
1082         if (cache == NULL)
1083                 return AE_ERROR;
1084         else
1085                 return AE_OK;
1086 }
1087
1088 /*******************************************************************************
1089  *
1090  * FUNCTION:    acpi_os_purge_cache
1091  *
1092  * PARAMETERS:  Cache           - Handle to cache object
1093  *
1094  * RETURN:      Status
1095  *
1096  * DESCRIPTION: Free all objects within the requested cache.
1097  *
1098  ******************************************************************************/
1099
1100 acpi_status acpi_os_purge_cache(acpi_cache_t * cache)
1101 {
1102         (void)kmem_cache_shrink(cache);
1103         return (AE_OK);
1104 }
1105
1106 /*******************************************************************************
1107  *
1108  * FUNCTION:    acpi_os_delete_cache
1109  *
1110  * PARAMETERS:  Cache           - Handle to cache object
1111  *
1112  * RETURN:      Status
1113  *
1114  * DESCRIPTION: Free all objects within the requested cache and delete the
1115  *              cache object.
1116  *
1117  ******************************************************************************/
1118
1119 acpi_status acpi_os_delete_cache(acpi_cache_t * cache)
1120 {
1121         kmem_cache_destroy(cache);
1122         return (AE_OK);
1123 }
1124
1125 /*******************************************************************************
1126  *
1127  * FUNCTION:    acpi_os_release_object
1128  *
1129  * PARAMETERS:  Cache       - Handle to cache object
1130  *              Object      - The object to be released
1131  *
1132  * RETURN:      None
1133  *
1134  * DESCRIPTION: Release an object to the specified cache.  If cache is full,
1135  *              the object is deleted.
1136  *
1137  ******************************************************************************/
1138
1139 acpi_status acpi_os_release_object(acpi_cache_t * cache, void *object)
1140 {
1141         kmem_cache_free(cache, object);
1142         return (AE_OK);
1143 }
1144
1145 /******************************************************************************
1146  *
1147  * FUNCTION:    acpi_os_validate_interface
1148  *
1149  * PARAMETERS:  interface           - Requested interface to be validated
1150  *
1151  * RETURN:      AE_OK if interface is supported, AE_SUPPORT otherwise
1152  *
1153  * DESCRIPTION: Match an interface string to the interfaces supported by the
1154  *              host. Strings originate from an AML call to the _OSI method.
1155  *
1156  *****************************************************************************/
1157
1158 acpi_status
1159 acpi_os_validate_interface (char *interface)
1160 {
1161
1162     return AE_SUPPORT;
1163 }
1164
1165
1166 /******************************************************************************
1167  *
1168  * FUNCTION:    acpi_os_validate_address
1169  *
1170  * PARAMETERS:  space_id             - ACPI space ID
1171  *              address             - Physical address
1172  *              length              - Address length
1173  *
1174  * RETURN:      AE_OK if address/length is valid for the space_id. Otherwise,
1175  *              should return AE_AML_ILLEGAL_ADDRESS.
1176  *
1177  * DESCRIPTION: Validate a system address via the host OS. Used to validate
1178  *              the addresses accessed by AML operation regions.
1179  *
1180  *****************************************************************************/
1181
1182 acpi_status
1183 acpi_os_validate_address (
1184     u8                   space_id,
1185     acpi_physical_address   address,
1186     acpi_size               length)
1187 {
1188
1189     return AE_OK;
1190 }
1191
1192
1193 #endif