blob: 2ad2351a983321e31c1a4aa6983dfd0dfe419c09 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: achware.h -- hardware specific interfaces
4 *
5 *****************************************************************************/
6
7/*
Bob Moorefbb7a2d2014-02-08 09:42:25 +08008 * Copyright (C) 2000 - 2014, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef __ACHWARE_H__
45#define __ACHWARE_H__
46
Bob Moore50df4d82008-12-31 03:01:23 +080047/* Values for the _SST predefined method */
Robert Moore44f6c012005-04-18 22:49:35 -040048
49#define ACPI_SST_INDICATOR_OFF 0
50#define ACPI_SST_WORKING 1
51#define ACPI_SST_WAKING 2
52#define ACPI_SST_SLEEPING 3
53#define ACPI_SST_SLEEP_CONTEXT 4
54
Robert Moore44f6c012005-04-18 22:49:35 -040055/*
56 * hwacpi - high level functions
57 */
Len Brown4be44fc2005-08-05 00:44:28 -040058acpi_status acpi_hw_set_mode(u32 mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Len Brown4be44fc2005-08-05 00:44:28 -040060u32 acpi_hw_get_mode(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
Robert Moore44f6c012005-04-18 22:49:35 -040062/*
63 * hwregs - ACPI Register I/O
64 */
Bob Moorec6b57742009-06-24 09:44:06 +080065acpi_status
66acpi_hw_validate_register(struct acpi_generic_address *reg,
67 u8 max_bit_width, u64 *address);
68
69acpi_status acpi_hw_read(u32 *value, struct acpi_generic_address *reg);
70
71acpi_status acpi_hw_write(u32 value, struct acpi_generic_address *reg);
72
Len Brown4be44fc2005-08-05 00:44:28 -040073struct acpi_bit_register_info *acpi_hw_get_bit_register_info(u32 register_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Bob Moore32c9ef92009-02-18 14:36:05 +080075acpi_status acpi_hw_write_pm1_control(u32 pm1a_control, u32 pm1b_control);
76
77acpi_status acpi_hw_register_read(u32 register_id, u32 *return_value);
Len Brown4be44fc2005-08-05 00:44:28 -040078
Alexey Starikovskiyd30dc9ab2007-09-30 22:39:36 +040079acpi_status acpi_hw_register_write(u32 register_id, u32 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
Bob Moored8c71b62007-02-02 19:48:21 +030081acpi_status acpi_hw_clear_acpi_status(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082
Robert Moore44f6c012005-04-18 22:49:35 -040083/*
Bob Moore70958572012-02-14 18:47:42 +080084 * hwsleep - sleep/wake support (Legacy sleep registers)
85 */
Len Brown3f6f49c2012-07-26 20:08:54 -040086acpi_status acpi_hw_legacy_sleep(u8 sleep_state);
Bob Moore70958572012-02-14 18:47:42 +080087
Len Brown3f6f49c2012-07-26 20:08:54 -040088acpi_status acpi_hw_legacy_wake_prep(u8 sleep_state);
Bob Moore70958572012-02-14 18:47:42 +080089
Len Brown3f6f49c2012-07-26 20:08:54 -040090acpi_status acpi_hw_legacy_wake(u8 sleep_state);
Bob Moore70958572012-02-14 18:47:42 +080091
92/*
93 * hwesleep - sleep/wake support (Extended FADT-V5 sleep registers)
Bob Moore2feec472012-02-14 15:00:53 +080094 */
Bob Mooref99648b2012-02-14 18:43:03 +080095void acpi_hw_execute_sleep_method(char *method_name, u32 integer_argument);
Bob Moore2feec472012-02-14 15:00:53 +080096
Len Brown3f6f49c2012-07-26 20:08:54 -040097acpi_status acpi_hw_extended_sleep(u8 sleep_state);
Bob Moore2feec472012-02-14 15:00:53 +080098
Len Brown3f6f49c2012-07-26 20:08:54 -040099acpi_status acpi_hw_extended_wake_prep(u8 sleep_state);
Bob Moore2feec472012-02-14 15:00:53 +0800100
Len Brown3f6f49c2012-07-26 20:08:54 -0400101acpi_status acpi_hw_extended_wake(u8 sleep_state);
Bob Moore2feec472012-02-14 15:00:53 +0800102
Bob Moore2feec472012-02-14 15:00:53 +0800103/*
Bob Moore7f071902009-03-19 09:37:47 +0800104 * hwvalid - Port I/O with validation
105 */
106acpi_status acpi_hw_read_port(acpi_io_address address, u32 *value, u32 width);
107
108acpi_status acpi_hw_write_port(acpi_io_address address, u32 value, u32 width);
109
110/*
Robert Moore44f6c012005-04-18 22:49:35 -0400111 * hwgpe - GPE support
112 */
Feng Tang1d94e1e2012-08-17 11:10:02 +0800113u32 acpi_hw_get_gpe_register_bit(struct acpi_gpe_event_info *gpe_event_info);
Rafael J. Wysockie4e9a732010-06-08 10:48:26 +0200114
Rafael J. Wysockifd247442010-06-08 10:49:08 +0200115acpi_status
Lin Mingda503372010-12-13 13:39:37 +0800116acpi_hw_low_set_gpe(struct acpi_gpe_event_info *gpe_event_info, u32 action);
Bob Mooree38e8a02008-06-13 08:28:55 +0800117
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400119acpi_hw_disable_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
Bob Mooree97d6bf2008-12-30 09:45:17 +0800120 struct acpi_gpe_block_info *gpe_block, void *context);
Len Brown4be44fc2005-08-05 00:44:28 -0400121
122acpi_status acpi_hw_clear_gpe(struct acpi_gpe_event_info *gpe_event_info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
124acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400125acpi_hw_clear_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
Bob Mooree97d6bf2008-12-30 09:45:17 +0800126 struct acpi_gpe_block_info *gpe_block, void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400129acpi_hw_get_gpe_status(struct acpi_gpe_event_info *gpe_event_info,
130 acpi_event_status * event_status);
Len Brown4be44fc2005-08-05 00:44:28 -0400131
132acpi_status acpi_hw_disable_all_gpes(void);
133
134acpi_status acpi_hw_enable_all_runtime_gpes(void);
135
136acpi_status acpi_hw_enable_all_wakeup_gpes(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137
138acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400139acpi_hw_enable_runtime_gpe_block(struct acpi_gpe_xrupt_info *gpe_xrupt_info,
Bob Mooree97d6bf2008-12-30 09:45:17 +0800140 struct acpi_gpe_block_info *gpe_block,
141 void *context);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142
Robert Moore44f6c012005-04-18 22:49:35 -0400143/*
Bob Moore95abccb2010-09-15 13:22:46 +0800144 * hwpci - PCI configuration support
145 */
146acpi_status
147acpi_hw_derive_pci_id(struct acpi_pci_id *pci_id,
148 acpi_handle root_pci_device, acpi_handle pci_region);
149
Len Brown4be44fc2005-08-05 00:44:28 -0400150#endif /* __ACHWARE_H__ */