1    /*
2     * Some or all of this work - Copyright (c) 2006 - 2021, Intel Corp.
3     * All rights reserved.
4     *
5     * Redistribution and use in source and binary forms, with or without modification,
6     * are permitted provided that the following conditions are met:
7     *
8     * Redistributions of source code must retain the above copyright notice,
9     * this list of conditions and the following disclaimer.
10     * Redistributions in binary form must reproduce the above copyright notice,
11     * this list of conditions and the following disclaimer in the documentation
12     * and/or other materials provided with the distribution.
13     * Neither the name of Intel Corporation nor the names of its contributors
14     * may be used to endorse or promote products derived from this software
15     * without specific prior written permission.
16     *
17     * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18     * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20     * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21     * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23     * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24     * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25     * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26     * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27     */
28    /*
29     * Data type conversion and manipulation
30     *
31     * Convert Buffer To String
32     */
33    Name (Z048, 0x30)
34    Name (P330, Package (0x0D)
35    {
36        Buffer (0x08)
37        {
38             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
39        },
40
41        Buffer (0xC8)
42        {
43            /* 0000 */  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,  // ........
44            /* 0008 */  0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10,  // ........
45            /* 0010 */  0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18,  // ........
46            /* 0018 */  0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20,  // .......
47            /* 0020 */  0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28,  // !"#$%&'(
48            /* 0028 */  0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30,  // )*+,-./0
49            /* 0030 */  0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38,  // 12345678
50            /* 0038 */  0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F, 0x40,  // 9:;<=>?@
51            /* 0040 */  0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48,  // ABCDEFGH
52            /* 0048 */  0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, 0x50,  // IJKLMNOP
53            /* 0050 */  0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58,  // QRSTUVWX
54            /* 0058 */  0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F, 0x60,  // YZ[\]^_`
55            /* 0060 */  0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,  // abcdefgh
56            /* 0068 */  0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70,  // ijklmnop
57            /* 0070 */  0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78,  // qrstuvwx
58            /* 0078 */  0x79, 0x7A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F, 0x80,  // yz{|}~..
59            /* 0080 */  0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88,  // ........
60            /* 0088 */  0x89, 0x8A, 0x8B, 0x8C, 0x8D, 0x8E, 0x8F, 0x90,  // ........
61            /* 0090 */  0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98,  // ........
62            /* 0098 */  0x99, 0x9A, 0x9B, 0x9C, 0x9D, 0x9E, 0x9F, 0xA0,  // ........
63            /* 00A0 */  0xA1, 0xA2, 0xA3, 0xA4, 0xA5, 0xA6, 0xA7, 0xA8,  // ........
64            /* 00A8 */  0xA9, 0xAA, 0xAB, 0xAC, 0xAD, 0xAE, 0xAF, 0xB0,  // ........
65            /* 00B0 */  0xB1, 0xB2, 0xB3, 0xB4, 0xB5, 0xB6, 0xB7, 0xB8,  // ........
66            /* 00B8 */  0xB9, 0xBA, 0xBB, 0xBC, 0xBD, 0xBE, 0xBF, 0xC0,  // ........
67            /* 00C0 */  0xC1, 0xC2, 0xC3, 0xC4, 0xC5, 0xC6, 0xC7, 0xC8   // ........
68        },
69
70        Buffer (0x08)
71        {
72             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
73        },
74
75        Buffer (0x80)
76        {
77            /* 0000 */  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,  // ........
78            /* 0008 */  0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10,  // ........
79            /* 0010 */  0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18,  // ........
80            /* 0018 */  0x19, 0x1A, 0x1B, 0x1C, 0x1D, 0x1E, 0x1F, 0x20,  // .......
81            /* 0020 */  0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28,  // !"#$%&'(
82            /* 0028 */  0x29, 0x2A, 0x2B, 0x2C, 0x2D, 0x2E, 0x2F, 0x30,  // )*+,-./0
83            /* 0030 */  0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38,  // 12345678
84            /* 0038 */  0x39, 0x3A, 0x3B, 0x3C, 0x3D, 0x3E, 0x3F, 0x40,  // 9:;<=>?@
85            /* 0040 */  0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48,  // ABCDEFGH
86            /* 0048 */  0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, 0x50,  // IJKLMNOP
87            /* 0050 */  0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58,  // QRSTUVWX
88            /* 0058 */  0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F, 0x60,  // YZ[\]^_`
89            /* 0060 */  0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68,  // abcdefgh
90            /* 0068 */  0x69, 0x6A, 0x6B, 0x6C, 0x6D, 0x6E, 0x6F, 0x70,  // ijklmnop
91            /* 0070 */  0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78,  // qrstuvwx
92            /* 0078 */  0x79, 0x7A, 0x7B, 0x7C, 0x7D, 0x7E, 0x7F, 0x80   // yz{|}~..
93        },
94
95        Buffer (0x08)
96        {
97             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
98        },
99
100        Buffer (0x10)
101        {
102            /* 0000 */  0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08,  // ........
103            /* 0008 */  0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F, 0x10   // ........
104        },
105
106        Buffer (0x08)
107        {
108             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
109        },
110
111        Buffer (0x08)
112        {
113             0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08   // ........
114        },
115
116        Buffer (0x08)
117        {
118             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
119        },
120
121        Buffer (0x04)
122        {
123             0x01, 0x02, 0x03, 0x04                           // ....
124        },
125
126        Buffer (0x08)
127        {
128             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
129        },
130
131        Buffer (0x01)
132        {
133             0x01                                             // .
134        },
135
136        Buffer (0x08)
137        {
138             0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF   // ........
139        }
140    })
141    Name (B330, Buffer (0x06)
142    {
143         0xC8, 0x80, 0x10, 0x08, 0x04, 0x01               // ......
144    })
145    /* Init buffer with the symbols 1-255 */
146
147    Method (M303, 2, NotSerialized)
148    {
149        Local0 = 0x00
150        While ((Local0 < Arg1))
151        {
152            Local1 = ((Local0 + 0x01) % 0x0100)
153            Arg0 [Local0] = Local1
154            Local0++
155        }
156    }
157
158    /* Verify the contents of result string */
159
160    Method (M305, 5, NotSerialized)
161    {
162        Local0 = 0x00
163        While ((Local0 < Arg2))
164        {
165            Local1 = ((Local0 + 0x01) % 0x0100)
166            If ((DerefOf (Arg1 [Local0]) != Local1))
167            {
168                ERR (Arg0, Z048, __LINE__, 0x00, 0x00, Local0, Arg4)
169            }
170
171            Local0++
172        }
173    }
174
175    /* Verify type, length of the obtained string, call to m305 */
176
177    Method (M307, 5, NotSerialized)
178    {
179        If ((ObjectType (Arg1) != 0x02))
180        {
181            ERR (Arg0, Z048, __LINE__, 0x00, 0x00, Arg2, "Type")
182        }
183        ElseIf ((SizeOf (Arg1) != Arg2))
184        {
185            ERR (Arg0, Z048, __LINE__, 0x00, 0x00, Arg2, "Sizeof")
186        }
187        Else
188        {
189            M305 (Arg0, Arg1, Arg2, Arg3, Arg4)
190        }
191    }
192
193    /* Check the surrounding control buffers are safe */
194
195    Method (M309, 3, NotSerialized)
196    {
197        /* control buffer */
198
199        Local1 = DerefOf (P330 [Arg1])
200        Local0 = 0x00
201        While ((Local0 < 0x08))
202        {
203            If ((DerefOf (Local1 [Local0]) != 0xFF))
204            {
205                ERR (Arg0, Z048, __LINE__, 0x00, 0x00, Local0, "buf8")
206            }
207
208            Local0++
209        }
210    }
211
212    /* Check all positions of null character (0-200) */
213
214    Method (M30A, 1, Serialized)
215    {
216        Name (LENS, Buffer (0x0A)
217        {
218            /* 0000 */  0xC8, 0xC7, 0x81, 0x80, 0x7F, 0x09, 0x08, 0x07,  // ........
219            /* 0008 */  0x01, 0x00                                       // ..
220        })
221        Name (BUF0, Buffer (0xFF){})
222        /* Buffer (255 bytes) initialized with non-zero bytes */
223
224        M303 (BUF0, 0xFF)
225        Local1 = 0x00
226        While ((Local1 < 0x0A))
227        {
228            /* Fill zero byte in position specified by LENS */
229
230            Local0 = DerefOf (LENS [Local1])
231            Local5 = DerefOf (BUF0 [Local0])
232            BUF0 [Local0] = 0x00
233            /* The contents of buffer is not more changed in checkings below */
234            /* Checking for unspecified Length parameter */
235            /* Invoke ToString without Length */
236            Local2 = ToString (BUF0, Ones)
237            M307 (Arg0, Local2, Local0, 0x01, "Omit")
238            /* Invoke ToString with Ones */
239
240            ToString (BUF0, Ones, Local2)
241            M307 (Arg0, Local2, Local0, 0x02, "Ones")
242            /* Checking for particular values of Length parameter (0, 32, 64...) */
243
244            Local3 = 0x00 /* Length */
245            While ((Local3 < 0x0191))
246            {
247                Local4 = Local0 /* expected size */
248                If ((Local3 < Local4))
249                {
250                    Local4 = Local3
251                }
252
253                ToString (BUF0, Local3, Local2)
254                M307 (Arg0, Local2, Local4, 0x03, "Size")
255                Local3 += 0x20
256            }
257
258            /* Restore position specified by LENS */
259
260            BUF0 [Local0] = Local5
261            Local1++
262        }
263    }
264
265    Method (M333, 1, NotSerialized)
266    {
267        Local0 = 0x00
268        Local0 = ToString (DerefOf (Arg0), Ones)
269        Debug = Local0
270    }
271
272    /* Check Buffer->Length effective condition. */
273    /* Don't put null characters. Check the surrounding */
274    /* control buffers are safe. */
275    Method (M30B, 1, Serialized)
276    {
277        Name (LOC8, 0x00)
278        Local5 = 0x00    /* index of control buffer 1 */
279        While ((LOC8 < 0x06))
280        {
281            /* Choose the buffer from package */
282
283            Local0 = DerefOf (B330 [LOC8])   /* length */
284            Local1 = (LOC8 * 0x02)           /* index of a buffer */
285            Local1 += 0x01
286            Local6 = (Local1 + 0x01)              /* index of control buffer 2 */
287            Store (P330 [Local1], Local4)      /* ref to test buffer */
288            /* Checking for unspecified Length parameter */
289            /* Invoke ToString without Length */
290            Local2 = ToString (DerefOf (Local4), Ones)
291            M307 (Arg0, Local2, Local0, 0x04, "Omit")
292            M309 (Arg0, Local5, 0x04)   /* check control buffers */
293            M309 (Arg0, Local6, 0x04)
294            /* Invoke ToString with Ones */
295
296            ToString (DerefOf (Local4), Ones, Local2)
297            M307 (Arg0, Local2, Local0, 0x05, "Ones")
298            M309 (Arg0, Local5, 0x05)   /* check control buffers */
299            M309 (Arg0, Local6, 0x05)
300            /* Checking for particular values of Length parameter */
301            /* exceeding (by 0, 1, 2, 3, ... 8) the actual lengths of Buffer */
302            Local7 = (Local0 + 0x09) /* Max. Length */
303            Local3 = Local0 /* Length */
304            While ((Local3 < Local7))
305            {
306                ToString (DerefOf (Local4), Local3, Local2)
307                M307 (Arg0, Local2, Local0, 0x06, "Size")
308                M309 (Arg0, Local5, 0x06)   /* check control buffers */
309                M309 (Arg0, Local6, 0x06)
310                Local3++
311            }
312
313            Local5 = Local6
314            LOC8++
315        }
316    }
317
318    /* Check zero length buffer, and, in passing, */
319    /* dynamically allocated buffers. */
320    Method (M30C, 1, Serialized)
321    {
322        Name (LENS, Buffer (0x04)
323        {
324             0xC8, 0xC7, 0x01, 0x00                           // ....
325        })
326        Local1 = 0x00
327        While ((Local1 < 0x04))
328        {
329            /* Allocate buffer dynamically and initialize it, */
330            /* don't put null characters. */
331            Local0 = DerefOf (LENS [Local1])
332            Local4 = Buffer (Local0){}
333            M303 (Local4, Local0)
334            /* Checking for unspecified Length parameter */
335            /* Invoke ToString without Length */
336            Local2 = ToString (Local4, Ones)
337            M307 (Arg0, Local2, Local0, 0x07, "Omit")
338            /* Invoke ToString with Ones */
339
340            ToString (Local4, Ones, Local2)
341            M307 (Arg0, Local2, Local0, 0x08, "Ones")
342            /* Allocate buffer of +1 size and put null characters */
343            /* into the last byte. */
344            Local4 = Buffer ((Local0 + 0x01)){}
345            M303 (Local4, Local0)
346            Local4 [Local0] = 0x00
347            /* Invoke ToString without Length */
348
349            Local2 = ToString (Local4, Ones)
350            M307 (Arg0, Local2, Local0, 0x09, "Omit")
351            /* Invoke ToString with Ones */
352
353            ToString (Local4, Ones, Local2)
354            M307 (Arg0, Local2, Local0, 0x0A, "Ones")
355            Local1++
356        }
357    }
358
359    /* Run-method */
360
361    Method (TOS0, 0, Serialized)
362    {
363        Debug = "TEST: TOS0, Convert Buffer To String"
364        M30A (__METHOD__)
365        M30B (__METHOD__)
366        M30C (__METHOD__)
367    }
368