Subversion Repositories Kolibri OS

Rev

Rev 1498 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /******************************************************************************
  2.  *
  3.  * Module Name: dtfield.c - Code generation for individual source fields
  4.  *
  5.  *****************************************************************************/
  6.  
  7. /******************************************************************************
  8.  *
  9.  * 1. Copyright Notice
  10.  *
  11.  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  12.  * All rights reserved.
  13.  *
  14.  * 2. License
  15.  *
  16.  * 2.1. This is your license from Intel Corp. under its intellectual property
  17.  * rights.  You may have additional license terms from the party that provided
  18.  * you this software, covering your right to use that party's intellectual
  19.  * property rights.
  20.  *
  21.  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22.  * copy of the source code appearing in this file ("Covered Code") an
  23.  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24.  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25.  * make derivatives, distribute, use and display any portion of the Covered
  26.  * Code in any form, with the right to sublicense such rights; and
  27.  *
  28.  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29.  * license (with the right to sublicense), under only those claims of Intel
  30.  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31.  * offer to sell, and import the Covered Code and derivative works thereof
  32.  * solely to the minimum extent necessary to exercise the above copyright
  33.  * license, and in no event shall the patent license extend to any additions
  34.  * to or modifications of the Original Intel Code.  No other license or right
  35.  * is granted directly or by implication, estoppel or otherwise;
  36.  *
  37.  * The above copyright and patent license is granted only if the following
  38.  * conditions are met:
  39.  *
  40.  * 3. Conditions
  41.  *
  42.  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43.  * Redistribution of source code of any substantial portion of the Covered
  44.  * Code or modification with rights to further distribute source must include
  45.  * the above Copyright Notice, the above License, this list of Conditions,
  46.  * and the following Disclaimer and Export Compliance provision.  In addition,
  47.  * Licensee must cause all Covered Code to which Licensee contributes to
  48.  * contain a file documenting the changes Licensee made to create that Covered
  49.  * Code and the date of any change.  Licensee must include in that file the
  50.  * documentation of any changes made by any predecessor Licensee.  Licensee
  51.  * must include a prominent statement that the modification is derived,
  52.  * directly or indirectly, from Original Intel Code.
  53.  *
  54.  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55.  * Redistribution of source code of any substantial portion of the Covered
  56.  * Code or modification without rights to further distribute source must
  57.  * include the following Disclaimer and Export Compliance provision in the
  58.  * documentation and/or other materials provided with distribution.  In
  59.  * addition, Licensee may not authorize further sublicense of source of any
  60.  * portion of the Covered Code, and must include terms to the effect that the
  61.  * license from Licensee to its licensee is limited to the intellectual
  62.  * property embodied in the software Licensee provides to its licensee, and
  63.  * not to intellectual property embodied in modifications its licensee may
  64.  * make.
  65.  *
  66.  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67.  * substantial portion of the Covered Code or modification must reproduce the
  68.  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69.  * provision in the documentation and/or other materials provided with the
  70.  * distribution.
  71.  *
  72.  * 3.4. Intel retains all right, title, and interest in and to the Original
  73.  * Intel Code.
  74.  *
  75.  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76.  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77.  * other dealings in products derived from or relating to the Covered Code
  78.  * without prior written authorization from Intel.
  79.  *
  80.  * 4. Disclaimer and Export Compliance
  81.  *
  82.  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83.  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84.  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85.  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86.  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87.  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88.  * PARTICULAR PURPOSE.
  89.  *
  90.  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91.  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92.  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93.  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94.  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95.  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96.  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97.  * LIMITED REMEDY.
  98.  *
  99.  * 4.3. Licensee shall not export, either directly or indirectly, any of this
  100.  * software or system incorporating such software without first obtaining any
  101.  * required license or other approval from the U. S. Department of Commerce or
  102.  * any other agency or department of the United States Government.  In the
  103.  * event Licensee exports any such software from the United States or
  104.  * re-exports any such software from a foreign destination, Licensee shall
  105.  * ensure that the distribution and export/re-export of the software is in
  106.  * compliance with all laws, regulations, orders, or other restrictions of the
  107.  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
  108.  * any of its subsidiaries will export/re-export any technical data, process,
  109.  * software, or service, directly or indirectly, to any country for which the
  110.  * United States government or any agency thereof requires an export license,
  111.  * other governmental approval, or letter of assurance, without first obtaining
  112.  * such license, approval or letter.
  113.  *
  114.  *****************************************************************************/
  115.  
  116. #define __DTFIELD_C__
  117.  
  118. #include "aslcompiler.h"
  119. #include "dtcompiler.h"
  120.  
  121. #define _COMPONENT          DT_COMPILER
  122.         ACPI_MODULE_NAME    ("dtfield")
  123.  
  124.  
  125. /* Local prototypes */
  126.  
  127. static void
  128. DtCompileString (
  129.     UINT8                   *Buffer,
  130.     DT_FIELD                *Field,
  131.     UINT32                  ByteLength);
  132.  
  133. static void
  134. DtCompileUnicode (
  135.     UINT8                   *Buffer,
  136.     DT_FIELD                *Field,
  137.     UINT32                  ByteLength);
  138.  
  139. static ACPI_STATUS
  140. DtCompileUuid (
  141.     UINT8                   *Buffer,
  142.     DT_FIELD                *Field,
  143.     UINT32                  ByteLength);
  144.  
  145. static char *
  146. DtNormalizeBuffer (
  147.     char                    *Buffer,
  148.     UINT32                  *Count);
  149.  
  150.  
  151. /******************************************************************************
  152.  *
  153.  * FUNCTION:    DtCompileOneField
  154.  *
  155.  * PARAMETERS:  Buffer              - Output buffer
  156.  *              Field               - Field to be compiled
  157.  *              ByteLength          - Byte length of the field
  158.  *              Type                - Field type
  159.  *
  160.  * RETURN:      None
  161.  *
  162.  * DESCRIPTION: Compile a field value to binary
  163.  *
  164.  *****************************************************************************/
  165.  
  166. void
  167. DtCompileOneField (
  168.     UINT8                   *Buffer,
  169.     DT_FIELD                *Field,
  170.     UINT32                  ByteLength,
  171.     UINT8                   Type,
  172.     UINT8                   Flags)
  173. {
  174.     ACPI_STATUS             Status;
  175.  
  176.     switch (Type)
  177.     {
  178.     case DT_FIELD_TYPE_INTEGER:
  179.         DtCompileInteger (Buffer, Field, ByteLength, Flags);
  180.         break;
  181.  
  182.     case DT_FIELD_TYPE_STRING:
  183.         DtCompileString (Buffer, Field, ByteLength);
  184.         break;
  185.  
  186.     case DT_FIELD_TYPE_UUID:
  187.         Status = DtCompileUuid (Buffer, Field, ByteLength);
  188.         if (ACPI_SUCCESS (Status))
  189.         {
  190.             break;
  191.         }
  192.  
  193.         /* Fall through. */
  194.  
  195.     case DT_FIELD_TYPE_BUFFER:
  196.         DtCompileBuffer (Buffer, Field->Value, Field, ByteLength);
  197.         break;
  198.  
  199.     case DT_FIELD_TYPE_UNICODE:
  200.         DtCompileUnicode (Buffer, Field, ByteLength);
  201.         break;
  202.  
  203.     case DT_FIELD_TYPE_DEVICE_PATH:
  204.         break;
  205.  
  206.     default:
  207.         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid field type");
  208.         break;
  209.     }
  210. }
  211.  
  212.  
  213. /******************************************************************************
  214.  *
  215.  * FUNCTION:    DtCompileString
  216.  *
  217.  * PARAMETERS:  Buffer              - Output buffer
  218.  *              Field               - String to be copied to buffer
  219.  *              ByteLength          - Maximum length of string
  220.  *
  221.  * RETURN:      None
  222.  *
  223.  * DESCRIPTION: Copy string to the buffer
  224.  *
  225.  *****************************************************************************/
  226.  
  227. static void
  228. DtCompileString (
  229.     UINT8                   *Buffer,
  230.     DT_FIELD                *Field,
  231.     UINT32                  ByteLength)
  232. {
  233.     UINT32                  Length;
  234.  
  235.  
  236.     Length = ACPI_STRLEN (Field->Value);
  237.  
  238.     /* Check if the string is too long for the field */
  239.  
  240.     if (Length > ByteLength)
  241.     {
  242.         sprintf (MsgBuffer, "Maximum %u characters", ByteLength);
  243.         DtError (ASL_ERROR, ASL_MSG_STRING_LENGTH, Field, MsgBuffer);
  244.         Length = ByteLength;
  245.     }
  246.  
  247.     ACPI_MEMCPY (Buffer, Field->Value, Length);
  248. }
  249.  
  250.  
  251. /******************************************************************************
  252.  *
  253.  * FUNCTION:    DtCompileUnicode
  254.  *
  255.  * PARAMETERS:  Buffer              - Output buffer
  256.  *              Field               - String to be copied to buffer
  257.  *              ByteLength          - Maximum length of string
  258.  *
  259.  * RETURN:      None
  260.  *
  261.  * DESCRIPTION: Convert ASCII string to Unicode string
  262.  *
  263.  * Note:  The Unicode string is 16 bits per character, no leading signature,
  264.  *        with a 16-bit terminating NULL.
  265.  *
  266.  *****************************************************************************/
  267.  
  268. static void
  269. DtCompileUnicode (
  270.     UINT8                   *Buffer,
  271.     DT_FIELD                *Field,
  272.     UINT32                  ByteLength)
  273. {
  274.     UINT32                  Count;
  275.     UINT32                  i;
  276.     char                    *AsciiString;
  277.     UINT16                  *UnicodeString;
  278.  
  279.  
  280.     AsciiString = Field->Value;
  281.     UnicodeString = (UINT16 *) Buffer;
  282.     Count = ACPI_STRLEN (AsciiString) + 1;
  283.  
  284.     /* Convert to Unicode string (including null terminator) */
  285.  
  286.     for (i = 0; i < Count; i++)
  287.     {
  288.         UnicodeString[i] = (UINT16) AsciiString[i];
  289.     }
  290. }
  291.  
  292.  
  293. /*******************************************************************************
  294.  *
  295.  * FUNCTION:    DtCompileUuid
  296.  *
  297.  * PARAMETERS:  Buffer              - Output buffer
  298.  *              Field               - String to be copied to buffer
  299.  *              ByteLength          - Maximum length of string
  300.  *
  301.  * RETURN:      None
  302.  *
  303.  * DESCRIPTION: Convert UUID string to 16-byte buffer
  304.  *
  305.  ******************************************************************************/
  306.  
  307. static ACPI_STATUS
  308. DtCompileUuid (
  309.     UINT8                   *Buffer,
  310.     DT_FIELD                *Field,
  311.     UINT32                  ByteLength)
  312. {
  313.     char                    *InString;
  314.     ACPI_STATUS             Status;
  315.  
  316.  
  317.     InString = Field->Value;
  318.  
  319.     Status = AuValidateUuid (InString);
  320.     if (ACPI_FAILURE (Status))
  321.     {
  322.         sprintf (MsgBuffer, "%s", Field->Value);
  323.         DtNameError (ASL_ERROR, ASL_MSG_INVALID_UUID, Field, MsgBuffer);
  324.     }
  325.     else
  326.     {
  327.         Status = AuConvertStringToUuid (InString, (char *) Buffer);
  328.     }
  329.  
  330.     return (Status);
  331. }
  332.  
  333.  
  334. /******************************************************************************
  335.  *
  336.  * FUNCTION:    DtCompileInteger
  337.  *
  338.  * PARAMETERS:  Buffer              - Output buffer
  339.  *              Field               - Field obj with Integer to be compiled
  340.  *              ByteLength          - Byte length of the integer
  341.  *              Flags               - Additional compile info
  342.  *
  343.  * RETURN:      None
  344.  *
  345.  * DESCRIPTION: Compile an integer. Supports integer expressions with C-style
  346.  *              operators.
  347.  *
  348.  *****************************************************************************/
  349.  
  350. void
  351. DtCompileInteger (
  352.     UINT8                   *Buffer,
  353.     DT_FIELD                *Field,
  354.     UINT32                  ByteLength,
  355.     UINT8                   Flags)
  356. {
  357.     UINT64                  Value;
  358.     UINT64                  MaxValue;
  359.     ACPI_STATUS             Status;
  360.  
  361.  
  362.     /* Output buffer byte length must be in range 1-8 */
  363.  
  364.     if ((ByteLength > 8) || (ByteLength == 0))
  365.     {
  366.         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field,
  367.             "Invalid internal Byte length");
  368.         return;
  369.     }
  370.  
  371.     /* Resolve integer expression to a single integer value */
  372.  
  373.     Status = DtResolveIntegerExpression (Field, &Value);
  374.     if (ACPI_FAILURE (Status))
  375.     {
  376.         return;
  377.     }
  378.  
  379.     /* Ensure that reserved fields are set to zero */
  380.     /* TBD: should we set to zero, or just make this an ERROR? */
  381.     /* TBD: Probably better to use a flag */
  382.  
  383.     if (!ACPI_STRCMP (Field->Name, "Reserved") &&
  384.         (Value != 0))
  385.     {
  386.         DtError (ASL_WARNING, ASL_MSG_RESERVED_VALUE, Field,
  387.             "Setting to zero");
  388.         Value = 0;
  389.     }
  390.  
  391.     /* Check if the value must be non-zero */
  392.  
  393.     if ((Value == 0) && (Flags & DT_NON_ZERO))
  394.     {
  395.         DtError (ASL_ERROR, ASL_MSG_ZERO_VALUE, Field, NULL);
  396.     }
  397.  
  398.     /*
  399.      * Generate the maximum value for the data type (ByteLength)
  400.      * Note: construct chosen for maximum portability
  401.      */
  402.     MaxValue = ((UINT64) (-1)) >> (64 - (ByteLength * 8));
  403.  
  404.     /* Validate that the input value is within range of the target */
  405.  
  406.     if (Value > MaxValue)
  407.     {
  408.         sprintf (MsgBuffer, "%8.8X%8.8X", ACPI_FORMAT_UINT64 (Value));
  409.         DtError (ASL_ERROR, ASL_MSG_INTEGER_SIZE, Field, MsgBuffer);
  410.     }
  411.  
  412.     ACPI_MEMCPY (Buffer, &Value, ByteLength);
  413.     return;
  414. }
  415.  
  416.  
  417. /******************************************************************************
  418.  *
  419.  * FUNCTION:    DtNormalizeBuffer
  420.  *
  421.  * PARAMETERS:  Buffer              - Input buffer
  422.  *              Count               - Output the count of hex number in
  423.  *                                    the Buffer
  424.  *
  425.  * RETURN:      The normalized buffer, freed by caller
  426.  *
  427.  * DESCRIPTION: [1A,2B,3C,4D] or 1A, 2B, 3C, 4D will be normalized
  428.  *              to 1A 2B 3C 4D
  429.  *
  430.  *****************************************************************************/
  431.  
  432. static char *
  433. DtNormalizeBuffer (
  434.     char                    *Buffer,
  435.     UINT32                  *Count)
  436. {
  437.     char                    *NewBuffer;
  438.     char                    *TmpBuffer;
  439.     UINT32                  BufferCount = 0;
  440.     BOOLEAN                 Separator = TRUE;
  441.     char                    c;
  442.  
  443.  
  444.     NewBuffer = UtLocalCalloc (ACPI_STRLEN (Buffer) + 1);
  445.     TmpBuffer = NewBuffer;
  446.  
  447.     while ((c = *Buffer++))
  448.     {
  449.         switch (c)
  450.         {
  451.         /* Valid separators */
  452.  
  453.         case '[':
  454.         case ']':
  455.         case ' ':
  456.         case ',':
  457.             Separator = TRUE;
  458.             break;
  459.  
  460.         default:
  461.             if (Separator)
  462.             {
  463.                 /* Insert blank as the standard separator */
  464.  
  465.                 if (NewBuffer[0])
  466.                 {
  467.                     *TmpBuffer++ = ' ';
  468.                     BufferCount++;
  469.                 }
  470.  
  471.                 Separator = FALSE;
  472.             }
  473.  
  474.             *TmpBuffer++ = c;
  475.             break;
  476.         }
  477.     }
  478.  
  479.     *Count = BufferCount + 1;
  480.     return (NewBuffer);
  481. }
  482.  
  483.  
  484. /******************************************************************************
  485.  *
  486.  * FUNCTION:    DtCompileBuffer
  487.  *
  488.  * PARAMETERS:  Buffer              - Output buffer
  489.  *              StringValue         - Integer list to be compiled
  490.  *              Field               - Current field object
  491.  *              ByteLength          - Byte length of the integer list
  492.  *
  493.  * RETURN:      Count of remaining data in the input list
  494.  *
  495.  * DESCRIPTION: Compile and pack an integer list, for example
  496.  *              "AA 1F 20 3B" ==> Buffer[] = {0xAA,0x1F,0x20,0x3B}
  497.  *
  498.  *****************************************************************************/
  499.  
  500. UINT32
  501. DtCompileBuffer (
  502.     UINT8                   *Buffer,
  503.     char                    *StringValue,
  504.     DT_FIELD                *Field,
  505.     UINT32                  ByteLength)
  506. {
  507.     ACPI_STATUS             Status;
  508.     char                    Hex[3];
  509.     UINT64                  Value;
  510.     UINT32                  i;
  511.     UINT32                  Count;
  512.  
  513.  
  514.     /* Allow several different types of value separators */
  515.  
  516.     StringValue = DtNormalizeBuffer (StringValue, &Count);
  517.  
  518.     Hex[2] = 0;
  519.     for (i = 0; i < Count; i++)
  520.     {
  521.         /* Each element of StringValue is three chars */
  522.  
  523.         Hex[0] = StringValue[(3 * i)];
  524.         Hex[1] = StringValue[(3 * i) + 1];
  525.  
  526.         /* Convert one hex byte */
  527.  
  528.         Value = 0;
  529.         Status = DtStrtoul64 (Hex, &Value);
  530.         if (ACPI_FAILURE (Status))
  531.         {
  532.             DtError (ASL_ERROR, ASL_MSG_BUFFER_ELEMENT, Field, MsgBuffer);
  533.             return (ByteLength - Count);
  534.         }
  535.  
  536.         Buffer[i] = (UINT8) Value;
  537.     }
  538.  
  539.     ACPI_FREE (StringValue);
  540.     return (ByteLength - Count);
  541. }
  542.  
  543.  
  544. /******************************************************************************
  545.  *
  546.  * FUNCTION:    DtCompileFlag
  547.  *
  548.  * PARAMETERS:  Buffer              - Output buffer
  549.  *              Field               - Field to be compiled
  550.  *              Info                - Flag info
  551.  *
  552.  * RETURN:
  553.  *
  554.  * DESCRIPTION: Compile a flag
  555.  *
  556.  *****************************************************************************/
  557.  
  558. void
  559. DtCompileFlag (
  560.     UINT8                   *Buffer,
  561.     DT_FIELD                *Field,
  562.     ACPI_DMTABLE_INFO       *Info)
  563. {
  564.     UINT64                  Value = 0;
  565.     UINT32                  BitLength = 1;
  566.     UINT8                   BitPosition = 0;
  567.     ACPI_STATUS             Status;
  568.  
  569.  
  570.     Status = DtStrtoul64 (Field->Value, &Value);
  571.     if (ACPI_FAILURE (Status))
  572.     {
  573.         DtError (ASL_ERROR, ASL_MSG_INVALID_HEX_INTEGER, Field, NULL);
  574.     }
  575.  
  576.     switch (Info->Opcode)
  577.     {
  578.     case ACPI_DMT_FLAG0:
  579.     case ACPI_DMT_FLAG1:
  580.     case ACPI_DMT_FLAG2:
  581.     case ACPI_DMT_FLAG3:
  582.     case ACPI_DMT_FLAG4:
  583.     case ACPI_DMT_FLAG5:
  584.     case ACPI_DMT_FLAG6:
  585.     case ACPI_DMT_FLAG7:
  586.  
  587.         BitPosition = Info->Opcode;
  588.         BitLength = 1;
  589.         break;
  590.  
  591.     case ACPI_DMT_FLAGS0:
  592.  
  593.         BitPosition = 0;
  594.         BitLength = 2;
  595.         break;
  596.  
  597.  
  598.     case ACPI_DMT_FLAGS2:
  599.  
  600.         BitPosition = 2;
  601.         BitLength = 2;
  602.         break;
  603.  
  604.     default:
  605.  
  606.         DtFatal (ASL_MSG_COMPILER_INTERNAL, Field, "Invalid flag opcode");
  607.         break;
  608.     }
  609.  
  610.     /* Check range of the input flag value */
  611.  
  612.     if (Value >= ((UINT64) 1 << BitLength))
  613.     {
  614.         sprintf (MsgBuffer, "Maximum %u bit", BitLength);
  615.         DtError (ASL_ERROR, ASL_MSG_FLAG_VALUE, Field, MsgBuffer);
  616.         Value = 0;
  617.     }
  618.  
  619.     *Buffer |= (UINT8) (Value << BitPosition);
  620. }
  621.