1 /*******************************************************************************
3 * Module Name: rsirq - IRQ resource descriptors
5 ******************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
44 #include <acpi/acpi.h>
45 #include <acpi/acresrc.h>
47 #define _COMPONENT ACPI_RESOURCES
48 ACPI_MODULE_NAME("rsirq")
50 /*******************************************************************************
52 * FUNCTION: acpi_rs_irq_resource
54 * PARAMETERS: byte_stream_buffer - Pointer to the resource input byte
56 * bytes_consumed - Pointer to where the number of bytes
57 * consumed the byte_stream_buffer is
59 * output_buffer - Pointer to the return data buffer
60 * structure_size - Pointer to where the number of bytes
61 * in the return data struct is returned
65 * DESCRIPTION: Take the resource byte stream and fill out the appropriate
66 * structure pointed to by the output_buffer. Return the
67 * number of bytes consumed from the byte stream.
69 ******************************************************************************/
71 acpi_rs_irq_resource(u8
* byte_stream_buffer
,
72 acpi_size
* bytes_consumed
,
73 u8
** output_buffer
, acpi_size
* structure_size
)
75 u8
*buffer
= byte_stream_buffer
;
76 struct acpi_resource
*output_struct
= (void *)*output_buffer
;
81 acpi_size struct_size
= ACPI_SIZEOF_RESOURCE(struct acpi_resource_irq
);
83 ACPI_FUNCTION_TRACE("rs_irq_resource");
86 * The number of bytes consumed are contained in the descriptor
90 *bytes_consumed
= (temp8
& 0x03) + 1;
91 output_struct
->id
= ACPI_RSTYPE_IRQ
;
93 /* Point to the 16-bits of Bytes 1 and 2 */
96 ACPI_MOVE_16_TO_16(&temp16
, buffer
);
98 output_struct
->data
.irq
.number_of_interrupts
= 0;
100 /* Decode the IRQ bits */
102 for (i
= 0, index
= 0; index
< 16; index
++) {
103 if ((temp16
>> index
) & 0x01) {
104 output_struct
->data
.irq
.interrupts
[i
] = index
;
109 /* Zero interrupts is valid */
111 output_struct
->data
.irq
.number_of_interrupts
= i
;
113 /* Calculate the structure size based upon the number of interrupts */
115 struct_size
+= ((acpi_size
) i
- 1) * 4;
118 /* Point to Byte 3 if it is used */
120 if (4 == *bytes_consumed
) {
124 /* Check for HE, LL interrupts */
126 switch (temp8
& 0x09) {
128 output_struct
->data
.irq
.edge_level
=
130 output_struct
->data
.irq
.active_high_low
=
135 output_struct
->data
.irq
.edge_level
=
136 ACPI_LEVEL_SENSITIVE
;
137 output_struct
->data
.irq
.active_high_low
=
143 * Only _LL and _HE polarity/trigger interrupts
144 * are allowed (ACPI spec, section "IRQ Format")
145 * so 0x00 and 0x09 are illegal.
147 ACPI_DEBUG_PRINT((ACPI_DB_ERROR
,
148 "Invalid interrupt polarity/trigger in resource list, %X\n",
150 return_ACPI_STATUS(AE_BAD_DATA
);
153 /* Check for sharable */
155 output_struct
->data
.irq
.shared_exclusive
= (temp8
>> 3) & 0x01;
158 * Assume Edge Sensitive, Active High, Non-Sharable
159 * per ACPI Specification
161 output_struct
->data
.irq
.edge_level
= ACPI_EDGE_SENSITIVE
;
162 output_struct
->data
.irq
.active_high_low
= ACPI_ACTIVE_HIGH
;
163 output_struct
->data
.irq
.shared_exclusive
= ACPI_EXCLUSIVE
;
166 /* Set the Length parameter */
168 output_struct
->length
= (u32
) struct_size
;
170 /* Return the final size of the structure */
172 *structure_size
= struct_size
;
173 return_ACPI_STATUS(AE_OK
);
176 /*******************************************************************************
178 * FUNCTION: acpi_rs_irq_stream
180 * PARAMETERS: linked_list - Pointer to the resource linked list
181 * output_buffer - Pointer to the user's return buffer
182 * bytes_consumed - Pointer to where the number of bytes
183 * used in the output_buffer is returned
187 * DESCRIPTION: Take the linked list resource structure and fills in the
188 * the appropriate bytes in a byte stream
190 ******************************************************************************/
193 acpi_rs_irq_stream(struct acpi_resource
*linked_list
,
194 u8
** output_buffer
, acpi_size
* bytes_consumed
)
196 u8
*buffer
= *output_buffer
;
200 u8 IRqinfo_byte_needed
;
202 ACPI_FUNCTION_TRACE("rs_irq_stream");
205 * The descriptor field is set based upon whether a third byte is
206 * needed to contain the IRQ Information.
208 if (ACPI_EDGE_SENSITIVE
== linked_list
->data
.irq
.edge_level
&&
209 ACPI_ACTIVE_HIGH
== linked_list
->data
.irq
.active_high_low
&&
210 ACPI_EXCLUSIVE
== linked_list
->data
.irq
.shared_exclusive
) {
212 IRqinfo_byte_needed
= FALSE
;
215 IRqinfo_byte_needed
= TRUE
;
221 /* Loop through all of the interrupts and set the mask bits */
224 index
< linked_list
->data
.irq
.number_of_interrupts
; index
++) {
225 temp8
= (u8
) linked_list
->data
.irq
.interrupts
[index
];
226 temp16
|= 0x1 << temp8
;
229 ACPI_MOVE_16_TO_16(buffer
, &temp16
);
232 /* Set the IRQ Info byte if needed. */
234 if (IRqinfo_byte_needed
) {
236 temp8
= (u8
) ((linked_list
->data
.irq
.shared_exclusive
&
239 if (ACPI_LEVEL_SENSITIVE
== linked_list
->data
.irq
.edge_level
&&
240 ACPI_ACTIVE_LOW
== linked_list
->data
.irq
.active_high_low
) {
250 /* Return the number of bytes consumed in this operation */
252 *bytes_consumed
= ACPI_PTR_DIFF(buffer
, *output_buffer
);
253 return_ACPI_STATUS(AE_OK
);
256 /*******************************************************************************
258 * FUNCTION: acpi_rs_extended_irq_resource
260 * PARAMETERS: byte_stream_buffer - Pointer to the resource input byte
262 * bytes_consumed - Pointer to where the number of bytes
263 * consumed the byte_stream_buffer is
265 * output_buffer - Pointer to the return data buffer
266 * structure_size - Pointer to where the number of bytes
267 * in the return data struct is returned
271 * DESCRIPTION: Take the resource byte stream and fill out the appropriate
272 * structure pointed to by the output_buffer. Return the
273 * number of bytes consumed from the byte stream.
275 ******************************************************************************/
278 acpi_rs_extended_irq_resource(u8
* byte_stream_buffer
,
279 acpi_size
* bytes_consumed
,
280 u8
** output_buffer
, acpi_size
* structure_size
)
282 u8
*buffer
= byte_stream_buffer
;
283 struct acpi_resource
*output_struct
= (void *)*output_buffer
;
288 acpi_size struct_size
=
289 ACPI_SIZEOF_RESOURCE(struct acpi_resource_ext_irq
);
291 ACPI_FUNCTION_TRACE("rs_extended_irq_resource");
293 /* Get the Descriptor Length field */
296 ACPI_MOVE_16_TO_16(&temp16
, buffer
);
298 /* Validate minimum descriptor length */
301 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH
);
304 *bytes_consumed
= temp16
+ 3;
305 output_struct
->id
= ACPI_RSTYPE_EXT_IRQ
;
307 /* Point to the Byte3 */
312 output_struct
->data
.extended_irq
.producer_consumer
= temp8
& 0x01;
315 * Check for Interrupt Mode
317 * The definition of an Extended IRQ changed between ACPI spec v1.0b
318 * and ACPI spec 2.0 (section 6.4.3.6 in both).
320 * - Edge/Level are defined opposite in the table vs the headers
322 output_struct
->data
.extended_irq
.edge_level
=
323 (temp8
& 0x2) ? ACPI_EDGE_SENSITIVE
: ACPI_LEVEL_SENSITIVE
;
325 /* Check Interrupt Polarity */
327 output_struct
->data
.extended_irq
.active_high_low
= (temp8
>> 2) & 0x1;
329 /* Check for sharable */
331 output_struct
->data
.extended_irq
.shared_exclusive
= (temp8
>> 3) & 0x01;
333 /* Point to Byte4 (IRQ Table length) */
338 /* Must have at least one IRQ */
341 return_ACPI_STATUS(AE_AML_BAD_RESOURCE_LENGTH
);
344 output_struct
->data
.extended_irq
.number_of_interrupts
= temp8
;
347 * Add any additional structure size to properly calculate
348 * the next pointer at the end of this function
350 struct_size
+= (temp8
- 1) * 4;
352 /* Point to Byte5 (First IRQ Number) */
356 /* Cycle through every IRQ in the table */
358 for (index
= 0; index
< temp8
; index
++) {
359 ACPI_MOVE_32_TO_32(&output_struct
->data
.extended_irq
.
360 interrupts
[index
], buffer
);
362 /* Point to the next IRQ */
368 * This will leave us pointing to the Resource Source Index
369 * If it is present, then save it off and calculate the
370 * pointer to where the null terminated string goes:
371 * Each Interrupt takes 32-bits + the 5 bytes of the
372 * stream that are default.
374 * Note: Some resource descriptors will have an additional null, so
375 * we add 1 to the length.
377 if (*bytes_consumed
>
378 ((acpi_size
) output_struct
->data
.extended_irq
.number_of_interrupts
*
380 /* Dereference the Index */
383 output_struct
->data
.extended_irq
.resource_source
.index
=
386 /* Point to the String */
390 /* Point the String pointer to the end of this structure. */
392 output_struct
->data
.extended_irq
.resource_source
.string_ptr
=
393 (char *)((char *)output_struct
+ struct_size
);
396 output_struct
->data
.extended_irq
.resource_source
.string_ptr
;
398 /* Copy the string into the buffer */
409 /* Add the terminating null */
412 output_struct
->data
.extended_irq
.resource_source
.string_length
=
416 * In order for the struct_size to fall on a 32-bit boundary,
417 * calculate the length of the string and expand the
418 * struct_size to the next 32-bit boundary.
420 temp8
= (u8
) (index
+ 1);
421 struct_size
+= ACPI_ROUND_UP_to_32_bITS(temp8
);
423 output_struct
->data
.extended_irq
.resource_source
.index
= 0;
424 output_struct
->data
.extended_irq
.resource_source
.string_length
=
426 output_struct
->data
.extended_irq
.resource_source
.string_ptr
=
430 /* Set the Length parameter */
432 output_struct
->length
= (u32
) struct_size
;
434 /* Return the final size of the structure */
436 *structure_size
= struct_size
;
437 return_ACPI_STATUS(AE_OK
);
440 /*******************************************************************************
442 * FUNCTION: acpi_rs_extended_irq_stream
444 * PARAMETERS: linked_list - Pointer to the resource linked list
445 * output_buffer - Pointer to the user's return buffer
446 * bytes_consumed - Pointer to where the number of bytes
447 * used in the output_buffer is returned
451 * DESCRIPTION: Take the linked list resource structure and fills in the
452 * the appropriate bytes in a byte stream
454 ******************************************************************************/
457 acpi_rs_extended_irq_stream(struct acpi_resource
*linked_list
,
458 u8
** output_buffer
, acpi_size
* bytes_consumed
)
460 u8
*buffer
= *output_buffer
;
465 ACPI_FUNCTION_TRACE("rs_extended_irq_stream");
467 /* Set the Descriptor Type field */
469 *buffer
= ACPI_RDESC_TYPE_EXTENDED_XRUPT
;
472 /* Save a pointer to the Length field - to be filled in later */
474 length_field
= ACPI_CAST_PTR(u16
, buffer
);
477 /* Set the Interrupt vector flags */
479 temp8
= (u8
) (linked_list
->data
.extended_irq
.producer_consumer
& 0x01);
481 ((linked_list
->data
.extended_irq
.shared_exclusive
& 0x01) << 3);
484 * Set the Interrupt Mode
486 * The definition of an Extended IRQ changed between ACPI spec v1.0b
487 * and ACPI spec 2.0 (section 6.4.3.6 in both). This code does not
488 * implement the more restrictive definition of 1.0b
490 * - Edge/Level are defined opposite in the table vs the headers
492 if (ACPI_EDGE_SENSITIVE
== linked_list
->data
.extended_irq
.edge_level
) {
496 /* Set the Interrupt Polarity */
498 temp8
|= ((linked_list
->data
.extended_irq
.active_high_low
& 0x1) << 2);
503 /* Set the Interrupt table length */
505 temp8
= (u8
) linked_list
->data
.extended_irq
.number_of_interrupts
;
511 index
< linked_list
->data
.extended_irq
.number_of_interrupts
;
513 ACPI_MOVE_32_TO_32(buffer
,
514 &linked_list
->data
.extended_irq
.
519 /* Resource Source Index and Resource Source are optional */
521 if (0 != linked_list
->data
.extended_irq
.resource_source
.string_length
) {
523 (u8
) linked_list
->data
.extended_irq
.resource_source
.index
;
526 /* Copy the string */
528 ACPI_STRCPY((char *)buffer
,
529 linked_list
->data
.extended_irq
.resource_source
.
533 * Buffer needs to be set to the length of the string + one for the
537 (acpi_size
) (ACPI_STRLEN
538 (linked_list
->data
.extended_irq
.
539 resource_source
.string_ptr
) + 1);
542 /* Return the number of bytes consumed in this operation */
544 *bytes_consumed
= ACPI_PTR_DIFF(buffer
, *output_buffer
);
547 * Set the length field to the number of bytes consumed
548 * minus the header size (3 bytes)
550 *length_field
= (u16
) (*bytes_consumed
- 3);
551 return_ACPI_STATUS(AE_OK
);