include/acpi/acresrc.h

   1 /******************************************************************************
   2  *
   3  * Name: acresrc.h - Resource Manager function prototypes
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   9  * 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 __ACRESRC_H__
  45 #define __ACRESRC_H__
  46
  47 /* Need the AML resource descriptor structs */
  48
  49 #include "amlresrc.h"
  50
  51 /*
  52  * If possible, pack the following structures to byte alignment, since we
  53  * don't care about performance for debug output
  54  */
  55 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
  56 #pragma pack(1)
  57 #endif
  58
  59 /*
  60  * Individual entry for the resource conversion tables
  61  */
  62 typedef const struct acpi_rsconvert_info {
  63         u8 opcode;
  64         u8 resource_offset;
  65         u8 aml_offset;
  66         u8 value;
  67
  68 } acpi_rsconvert_info;
  69
  70 /* Resource conversion opcodes */
  71
  72 #define ACPI_RSC_INITGET                0
  73 #define ACPI_RSC_INITSET                1
  74 #define ACPI_RSC_FLAGINIT               2
  75 #define ACPI_RSC_1BITFLAG               3
  76 #define ACPI_RSC_2BITFLAG               4
  77 #define ACPI_RSC_COUNT                  5
  78 #define ACPI_RSC_COUNT16                6
  79 #define ACPI_RSC_LENGTH                 7
  80 #define ACPI_RSC_MOVE8                  8
  81 #define ACPI_RSC_MOVE16                 9
  82 #define ACPI_RSC_MOVE32                 10
  83 #define ACPI_RSC_MOVE64                 11
  84 #define ACPI_RSC_SET8                   12
  85 #define ACPI_RSC_DATA8                  13
  86 #define ACPI_RSC_ADDRESS                14
  87 #define ACPI_RSC_SOURCE                 15
  88 #define ACPI_RSC_SOURCEX                16
  89 #define ACPI_RSC_BITMASK                17
  90 #define ACPI_RSC_BITMASK16              18
  91 #define ACPI_RSC_EXIT_NE                19
  92 #define ACPI_RSC_EXIT_LE                20
  93
  94 /* Resource Conversion sub-opcodes */
  95
  96 #define ACPI_RSC_COMPARE_AML_LENGTH     0
  97 #define ACPI_RSC_COMPARE_VALUE          1
  98
  99 #define ACPI_RSC_TABLE_SIZE(d)          (sizeof (d) / sizeof (struct acpi_rsconvert_info))
 100
 101 #define ACPI_RS_OFFSET(f)               (u8) ACPI_OFFSET (struct acpi_resource,f)
 102 #define AML_OFFSET(f)                   (u8) ACPI_OFFSET (union aml_resource,f)
 103
 104 typedef const struct acpi_rsdump_info {
 105         u8 opcode;
 106         u8 offset;
 107         char *name;
 108         const char **pointer;
 109
 110 } acpi_rsdump_info;
 111
 112 /* Values for the Opcode field above */
 113
 114 #define ACPI_RSD_TITLE                  0
 115 #define ACPI_RSD_LITERAL                1
 116 #define ACPI_RSD_STRING                 2
 117 #define ACPI_RSD_UINT8                  3
 118 #define ACPI_RSD_UINT16                 4
 119 #define ACPI_RSD_UINT32                 5
 120 #define ACPI_RSD_UINT64                 6
 121 #define ACPI_RSD_1BITFLAG               7
 122 #define ACPI_RSD_2BITFLAG               8
 123 #define ACPI_RSD_SHORTLIST              9
 124 #define ACPI_RSD_LONGLIST               10
 125 #define ACPI_RSD_DWORDLIST              11
 126 #define ACPI_RSD_ADDRESS                12
 127 #define ACPI_RSD_SOURCE                 13
 128
 129 /* restore default alignment */
 130
 131 #pragma pack()
 132
 133 /* Resource tables indexed by internal resource type */
 134
 135 extern const u8 acpi_gbl_aml_resource_sizes[];
 136 extern struct acpi_rsconvert_info *acpi_gbl_set_resource_dispatch[];
 137
 138 /* Resource tables indexed by raw AML resource descriptor type */
 139
 140 extern struct acpi_rsconvert_info *acpi_gbl_get_resource_dispatch[];
 141
 142 extern const u8 acpi_gbl_resource_struct_sizes[];
 143
 144 /*
 145  * rscreate
 146  */
 147 acpi_status
 148 acpi_rs_create_resource_list(union acpi_operand_object *aml_buffer,
 149                              struct acpi_buffer *output_buffer);
 150
 151 acpi_status
 152 acpi_rs_create_aml_resources(struct acpi_resource *linked_list_buffer,
 153                              struct acpi_buffer *output_buffer);
 154
 155 acpi_status
 156 acpi_rs_create_pci_routing_table(union acpi_operand_object *package_object,
 157                                  struct acpi_buffer *output_buffer);
 158
 159 /*
 160  * rsutils
 161  */
 162 acpi_status
 163 acpi_rs_get_prt_method_data(acpi_handle handle, struct acpi_buffer *ret_buffer);
 164
 165 acpi_status
 166 acpi_rs_get_crs_method_data(acpi_handle handle, struct acpi_buffer *ret_buffer);
 167
 168 #ifdef  ACPI_FUTURE_USAGE
 169 acpi_status
 170 acpi_rs_get_prs_method_data(acpi_handle handle, struct acpi_buffer *ret_buffer);
 171 #endif                          /* ACPI_FUTURE_USAGE */
 172
 173 acpi_status
 174 acpi_rs_get_method_data(acpi_handle handle,
 175                         char *path, struct acpi_buffer *ret_buffer);
 176
 177 acpi_status
 178 acpi_rs_set_srs_method_data(acpi_handle handle, struct acpi_buffer *ret_buffer);
 179
 180 /*
 181  * rscalc
 182  */
 183 acpi_status
 184 acpi_rs_get_list_length(u8 * aml_buffer,
 185                         u32 aml_buffer_length, acpi_size * size_needed);
 186
 187 acpi_status
 188 acpi_rs_get_aml_length(struct acpi_resource *linked_list_buffer,
 189                        acpi_size * size_needed);
 190
 191 acpi_status
 192 acpi_rs_get_pci_routing_table_length(union acpi_operand_object *package_object,
 193                                      acpi_size * buffer_size_needed);
 194
 195 acpi_status
 196 acpi_rs_convert_aml_to_resources(u8 * aml_buffer,
 197                                  u32 aml_buffer_length, u8 * output_buffer);
 198
 199 acpi_status
 200 acpi_rs_convert_resources_to_aml(struct acpi_resource *resource,
 201                                  acpi_size aml_size_needed, u8 * output_buffer);
 202
 203 /*
 204  * rsaddr
 205  */
 206 void
 207 acpi_rs_set_address_common(union aml_resource *aml,
 208                            struct acpi_resource *resource);
 209
 210 u8
 211 acpi_rs_get_address_common(struct acpi_resource *resource,
 212                            union aml_resource *aml);
 213
 214 /*
 215  * rsmisc
 216  */
 217 acpi_status
 218 acpi_rs_convert_aml_to_resource(struct acpi_resource *resource,
 219                                 union aml_resource *aml,
 220                                 struct acpi_rsconvert_info *info);
 221
 222 acpi_status
 223 acpi_rs_convert_resource_to_aml(struct acpi_resource *resource,
 224                                 union aml_resource *aml,
 225                                 struct acpi_rsconvert_info *info);
 226
 227 /*
 228  * rsutils
 229  */
 230 void
 231 acpi_rs_move_data(void *destination,
 232                   void *source, u16 item_count, u8 move_type);
 233
 234 u8 acpi_rs_decode_bitmask(u16 mask, u8 * list);
 235
 236 u16 acpi_rs_encode_bitmask(u8 * list, u8 count);
 237
 238 acpi_rs_length
 239 acpi_rs_get_resource_source(acpi_rs_length resource_length,
 240                             acpi_rs_length minimum_length,
 241                             struct acpi_resource_source *resource_source,
 242                             union aml_resource *aml, char *string_ptr);
 243
 244 acpi_rsdesc_size
 245 acpi_rs_set_resource_source(union aml_resource *aml,
 246                             acpi_rs_length minimum_length,
 247                             struct acpi_resource_source *resource_source);
 248
 249 void
 250 acpi_rs_set_resource_header(u8 descriptor_type,
 251                             acpi_rsdesc_size total_length,
 252                             union aml_resource *aml);
 253
 254 void
 255 acpi_rs_set_resource_length(acpi_rsdesc_size total_length,
 256                             union aml_resource *aml);
 257
 258 /*
 259  * rsdump
 260  */
 261 void acpi_rs_dump_resource_list(struct acpi_resource *resource);
 262
 263 void acpi_rs_dump_irq_list(u8 * route_table);
 264
 265 /*
 266  * Resource conversion tables
 267  */
 268 extern struct acpi_rsconvert_info acpi_rs_convert_dma[];
 269 extern struct acpi_rsconvert_info acpi_rs_convert_end_dpf[];
 270 extern struct acpi_rsconvert_info acpi_rs_convert_io[];
 271 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_io[];
 272 extern struct acpi_rsconvert_info acpi_rs_convert_end_tag[];
 273 extern struct acpi_rsconvert_info acpi_rs_convert_memory24[];
 274 extern struct acpi_rsconvert_info acpi_rs_convert_generic_reg[];
 275 extern struct acpi_rsconvert_info acpi_rs_convert_memory32[];
 276 extern struct acpi_rsconvert_info acpi_rs_convert_fixed_memory32[];
 277 extern struct acpi_rsconvert_info acpi_rs_convert_address32[];
 278 extern struct acpi_rsconvert_info acpi_rs_convert_address16[];
 279 extern struct acpi_rsconvert_info acpi_rs_convert_ext_irq[];
 280 extern struct acpi_rsconvert_info acpi_rs_convert_address64[];
 281 extern struct acpi_rsconvert_info acpi_rs_convert_ext_address64[];
 282
 283 /* These resources require separate get/set tables */
 284
 285 extern struct acpi_rsconvert_info acpi_rs_get_irq[];
 286 extern struct acpi_rsconvert_info acpi_rs_get_start_dpf[];
 287 extern struct acpi_rsconvert_info acpi_rs_get_vendor_small[];
 288 extern struct acpi_rsconvert_info acpi_rs_get_vendor_large[];
 289
 290 extern struct acpi_rsconvert_info acpi_rs_set_irq[];
 291 extern struct acpi_rsconvert_info acpi_rs_set_start_dpf[];
 292 extern struct acpi_rsconvert_info acpi_rs_set_vendor[];
 293
 294 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
 295 /*
 296  * rsinfo
 297  */
 298 extern struct acpi_rsdump_info *acpi_gbl_dump_resource_dispatch[];
 299
 300 /*
 301  * rsdump
 302  */
 303 extern struct acpi_rsdump_info acpi_rs_dump_irq[];
 304 extern struct acpi_rsdump_info acpi_rs_dump_dma[];
 305 extern struct acpi_rsdump_info acpi_rs_dump_start_dpf[];
 306 extern struct acpi_rsdump_info acpi_rs_dump_end_dpf[];
 307 extern struct acpi_rsdump_info acpi_rs_dump_io[];
 308 extern struct acpi_rsdump_info acpi_rs_dump_fixed_io[];
 309 extern struct acpi_rsdump_info acpi_rs_dump_vendor[];
 310 extern struct acpi_rsdump_info acpi_rs_dump_end_tag[];
 311 extern struct acpi_rsdump_info acpi_rs_dump_memory24[];
 312 extern struct acpi_rsdump_info acpi_rs_dump_memory32[];
 313 extern struct acpi_rsdump_info acpi_rs_dump_fixed_memory32[];
 314 extern struct acpi_rsdump_info acpi_rs_dump_address16[];
 315 extern struct acpi_rsdump_info acpi_rs_dump_address32[];
 316 extern struct acpi_rsdump_info acpi_rs_dump_address64[];
 317 extern struct acpi_rsdump_info acpi_rs_dump_ext_address64[];
 318 extern struct acpi_rsdump_info acpi_rs_dump_ext_irq[];
 319 extern struct acpi_rsdump_info acpi_rs_dump_generic_reg[];
 320 #endif
 321
 322 #endif                          /* __ACRESRC_H__ */