File: TestDevicePathStringConversions.c

package info (click to toggle)
edk2 2025.11-4
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 338,436 kB
  • sloc: ansic: 2,166,377; asm: 270,725; perl: 235,301; python: 149,900; sh: 34,744; cpp: 23,311; makefile: 3,334; pascal: 1,602; xml: 806; lisp: 35; ruby: 16; sed: 6; tcl: 4
file content (370 lines) | stat: -rw-r--r-- 10,699 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
/** @file
  UEFI OS based application for unit testing the DevicePathLib.

  Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent

**/

#include "TestDevicePathLib.h"

typedef struct {
  EFI_DEVICE_PATH_PROTOCOL    *DevPath;
  CONST CHAR16                *DevPathString;
} DEVICE_PATH_CONVERSIONS_TEST_CONTEXT;

GLOBAL_REMOVE_IF_UNREFERENCED PCI_DEVICE_PATH  mPciDevicePathNode =
{
  // PCI device path - root port (0x2:0x0)
  {
    HARDWARE_DEVICE_PATH,
    HW_PCI_DP,
    {
      (UINT8)(sizeof (PCI_DEVICE_PATH)),
      (UINT8)((sizeof (PCI_DEVICE_PATH)) >> 8)
    }
  },
  0x2,
  0x0
};

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_HID_DEVICE_PATH  mAcpiPciRootHidDevicePathNode =
{
  // ACPI PCI root - PciRoot(0x0)
  {
    ACPI_DEVICE_PATH,
    ACPI_DP,
    {
      (UINT8)(sizeof (ACPI_HID_DEVICE_PATH)),
      (UINT8)((sizeof (ACPI_HID_DEVICE_PATH)) >> 8)
    }
  },
  EISA_PNP_ID (0x0A03),
  0
};

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_HID_DEVICE_PATH  mAcpiNonPciRootHidDevicePathNode =
{
  // Random ACPI device - ACPI(PNPB0C0, 1)
  {
    ACPI_DEVICE_PATH,
    ACPI_DP,
    {
      (UINT8)(sizeof (ACPI_HID_DEVICE_PATH)),
      (UINT8)((sizeof (ACPI_HID_DEVICE_PATH)) >> 8)
    }
  },
  EISA_PNP_ID (0xB0C0),
  1
};

#define HID_STR_SIZE  8
#define CID_STR_SIZE  8
#define UID_STR_SIZE  8

typedef struct {
  ACPI_EXTENDED_HID_DEVICE_PATH    AcpiEx;
  CHAR8                            HidStr[HID_STR_SIZE];
  CHAR8                            CidStr[CID_STR_SIZE];
  CHAR8                            UidStr[UID_STR_SIZE];
} ACPI_EXTENDED_HID_DEVICE_PATH_FULL;

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_EXTENDED_HID_DEVICE_PATH_FULL  mAcpiExtendedDevicePathFull =
{
  // ACPI Extended HID PciRoot device node
  {
    {
      ACPI_DEVICE_PATH,
      ACPI_EXTENDED_DP,
      {
        (UINT8)(sizeof (ACPI_EXTENDED_HID_DEVICE_PATH_FULL)),
        (UINT8)((sizeof (ACPI_EXTENDED_HID_DEVICE_PATH_FULL)) >> 8)
      }
    },
    0,
    0,
    0,
  },
  { 'P', 'N', 'P', 'B', '0', 'C', '0', '\0' }, // HIDSTR
  { 'P', 'N', 'P', '0', '0', '0', '1', '\0' }, // CIDSTR
  { 'U', 'I', 'D', '0', '0', '0', '0', '\0' } // UIDSTR
};

typedef struct {
  ACPI_EXTENDED_HID_DEVICE_PATH    AcpiEx;
  CHAR8                            HidStr[HID_STR_SIZE];
} ACPI_EXTENDED_HID_DEVICE_PATH_PARTIAL;

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_EXTENDED_HID_DEVICE_PATH_PARTIAL  mAcpiExtendedDevicePathPartial =
{
  {
    {
      ACPI_DEVICE_PATH,
      ACPI_EXTENDED_DP,
      {
        (UINT8)(sizeof (ACPI_EXTENDED_HID_DEVICE_PATH_PARTIAL)),
        (UINT8)((sizeof (ACPI_EXTENDED_HID_DEVICE_PATH_PARTIAL)) >> 8)
      }
    },
    0,
    2,
    0,
  },
  { 'P', 'N', 'P', 'B', '0', '\0', '\0', '\0' }, // HIDSTR
};

typedef struct {
  ACPI_EXTENDED_HID_DEVICE_PATH    AcpiEx;
  CHAR8                            UidStr[UID_STR_SIZE];
} ACPI_EXPANDED_DEVICE_PATH;

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_EXPANDED_DEVICE_PATH  mAcpiExpandedDevicePathUidOnly =
{
  {
    {
      ACPI_DEVICE_PATH,
      ACPI_EXTENDED_DP,
      {
        (UINT8)(sizeof (ACPI_EXPANDED_DEVICE_PATH)),
        (UINT8)((sizeof (ACPI_EXPANDED_DEVICE_PATH)) >> 8)
      }
    },
    EISA_PNP_ID (0xAAAA),
    0,
    0,
  },
  { '\0', 'U', 'I', 'D', '0', '0', '\0', '\0' } // UIDSTR
};

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_EXPANDED_DEVICE_PATH  mAcpiExpandedDevicePathUidOnlyWithCid =
{
  {
    {
      ACPI_DEVICE_PATH,
      ACPI_EXTENDED_DP,
      {
        (UINT8)(sizeof (ACPI_EXPANDED_DEVICE_PATH)),
        (UINT8)((sizeof (ACPI_EXPANDED_DEVICE_PATH)) >> 8)
      }
    },
    EISA_PNP_ID (0xAAAA),
    0,
    EISA_PNP_ID (0xAADD),
  },
  { '\0', 'U', 'I', 'D', '0', '0', '\0', '\0' } // UIDSTR
};

GLOBAL_REMOVE_IF_UNREFERENCED DEVICE_PATH_CONVERSIONS_TEST_CONTEXT  mDevPathNodeToFromTextContext[] = {
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mPciDevicePathNode,
    L"Pci(0x0,0x2)"
  },
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mAcpiPciRootHidDevicePathNode,
    L"PciRoot(0x0)"
  },
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mAcpiNonPciRootHidDevicePathNode,
    L"Acpi(PNPB0C0,0x1)"
  },
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mAcpiExtendedDevicePathFull,
    L"AcpiEx(@@@0000,@@@0000,0x0,PNPB0C0,UID0000,PNP0001)"
  },
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mAcpiExtendedDevicePathPartial,
    L"AcpiEx(@@@0000,@@@0000,0x2,PNPB0,,)"
  },
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mAcpiExpandedDevicePathUidOnly,
    L"AcpiExp(PNPAAAA,0,UID00)"
  },
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mAcpiExpandedDevicePathUidOnlyWithCid,
    L"AcpiExp(PNPAAAA,PNPAADD,UID00)"
  }
};

typedef struct {
  ACPI_HID_DEVICE_PATH        AcpiPath;
  PCI_DEVICE_PATH             PciPathRootPort;
  PCI_DEVICE_PATH             PciPathEndPoint;
  USB_DEVICE_PATH             UsbPath;
  EFI_DEVICE_PATH_PROTOCOL    End;
} TEST_CONVERSIONS_DEVICE_PATH;

GLOBAL_REMOVE_IF_UNREFERENCED TEST_CONVERSIONS_DEVICE_PATH  mConversionsDevicePath = {
  { // ACPI device path with root bridge EISA_PNP_ID
    {
      ACPI_DEVICE_PATH,
      ACPI_DP,
      {
        (UINT8)(sizeof (ACPI_HID_DEVICE_PATH)),
        (UINT8)((sizeof (ACPI_HID_DEVICE_PATH)) >> 8)
      }
    },
    EISA_PNP_ID (0x0A03),
    0
  },
  { // PCI device path - root port (0x2:0x0)
    {
      HARDWARE_DEVICE_PATH,
      HW_PCI_DP,
      {
        (UINT8)(sizeof (PCI_DEVICE_PATH)),
        (UINT8)((sizeof (PCI_DEVICE_PATH)) >> 8)
      }
    },
    0x2,
    0x0
  },
  { // PCI device path - endpoint (0x0:0x0)
    {
      HARDWARE_DEVICE_PATH,
      HW_PCI_DP,
      {
        (UINT8)(sizeof (PCI_DEVICE_PATH)),
        (UINT8)((sizeof (PCI_DEVICE_PATH)) >> 8)
      }
    },
    0x0,
    0x0
  },
  { // USB interface
    {
      MESSAGING_DEVICE_PATH,
      MSG_USB_DP,
      {
        (UINT8)(sizeof (USB_DEVICE_PATH)),
        (UINT8)((sizeof (USB_CLASS_DEVICE_PATH)) >> 8)
      }
    },
    0,
    2
  },
  {
    END_DEVICE_PATH_TYPE,
    END_ENTIRE_DEVICE_PATH_SUBTYPE,
    {
      (UINT8)(sizeof (EFI_DEVICE_PATH_PROTOCOL)),
      (UINT8)((sizeof (EFI_DEVICE_PATH_PROTOCOL)) >> 8)
    }
  }
};

GLOBAL_REMOVE_IF_UNREFERENCED DEVICE_PATH_CONVERSIONS_TEST_CONTEXT  mDevPathToFromTextContext[] = {
  {
    (EFI_DEVICE_PATH_PROTOCOL *)&mConversionsDevicePath,
    L"PciRoot(0x0)/Pci(0x0,0x2)/Pci(0x0,0x0)/USB(0x0,0x2)"
  }
};

UNIT_TEST_STATUS
EFIAPI
TestConvertDevicePathToText (
  IN UNIT_TEST_CONTEXT  Context
  )
{
  CHAR16                                *DevPathString;
  DEVICE_PATH_CONVERSIONS_TEST_CONTEXT  *TestContext;

  TestContext = (DEVICE_PATH_CONVERSIONS_TEST_CONTEXT *)Context;

  DevPathString = ConvertDevicePathToText (TestContext->DevPath, FALSE, FALSE);
  UT_ASSERT_EQUAL (StrLen (DevPathString), StrLen (TestContext->DevPathString));
  UT_ASSERT_MEM_EQUAL (DevPathString, TestContext->DevPathString, StrLen (TestContext->DevPathString));
  FreePool (DevPathString);

  return UNIT_TEST_PASSED;
}

UNIT_TEST_STATUS
EFIAPI
TestConvertTextToDevicePath (
  IN UNIT_TEST_CONTEXT  Context
  )
{
  EFI_DEVICE_PATH_PROTOCOL              *ConvertedDevPath;
  DEVICE_PATH_CONVERSIONS_TEST_CONTEXT  *TestContext;

  TestContext = (DEVICE_PATH_CONVERSIONS_TEST_CONTEXT *)Context;

  ConvertedDevPath = ConvertTextToDevicePath (TestContext->DevPathString);
  UT_ASSERT_EQUAL (GetDevicePathSize (ConvertedDevPath), GetDevicePathSize (TestContext->DevPath));
  UT_ASSERT_MEM_EQUAL (ConvertedDevPath, TestContext->DevPath, GetDevicePathSize (TestContext->DevPath));
  FreePool (ConvertedDevPath);

  return UNIT_TEST_PASSED;
}

UNIT_TEST_STATUS
EFIAPI
TestConvertDeviceNodeToText (
  IN UNIT_TEST_CONTEXT  Context
  )
{
  CHAR16                                *DevPathNodeString;
  DEVICE_PATH_CONVERSIONS_TEST_CONTEXT  *TestContext;

  TestContext = (DEVICE_PATH_CONVERSIONS_TEST_CONTEXT *)Context;

  DevPathNodeString = ConvertDeviceNodeToText (TestContext->DevPath, FALSE, FALSE);
  UT_ASSERT_EQUAL (StrLen (DevPathNodeString), StrLen (TestContext->DevPathString));
  UT_ASSERT_MEM_EQUAL (DevPathNodeString, TestContext->DevPathString, StrLen (TestContext->DevPathString));
  FreePool (DevPathNodeString);

  return UNIT_TEST_PASSED;
}

UNIT_TEST_STATUS
EFIAPI
TestConvertTextToDeviceNode (
  IN UNIT_TEST_CONTEXT  Context
  )
{
  EFI_DEVICE_PATH_PROTOCOL              *DevPath;
  DEVICE_PATH_CONVERSIONS_TEST_CONTEXT  *TestContext;

  TestContext = (DEVICE_PATH_CONVERSIONS_TEST_CONTEXT *)Context;

  DevPath = ConvertTextToDeviceNode (TestContext->DevPathString);
  UT_ASSERT_EQUAL (DevicePathNodeLength (DevPath), DevicePathNodeLength (TestContext->DevPath));
  UT_ASSERT_MEM_EQUAL (DevPath, TestContext->DevPath, DevicePathNodeLength (TestContext->DevPath));
  FreePool (DevPath);

  return UNIT_TEST_PASSED;
}

EFI_STATUS
CreateDevicePathStringConversionsTestSuite (
  IN UNIT_TEST_FRAMEWORK_HANDLE  Framework
  )
{
  EFI_STATUS              Status;
  UNIT_TEST_SUITE_HANDLE  DevicePathTextConversionSuite = NULL;
  UINTN                   Index;

  Status = CreateUnitTestSuite (&DevicePathTextConversionSuite, Framework, "Device path text conversion operations test suite", "Common.DevicePath.TextConversions", NULL, NULL);
  if (EFI_ERROR (Status)) {
    DEBUG ((DEBUG_ERROR, "Failed to create device path text conversions test suite\n"));
    return Status;
  }

  for (Index = 0; Index < ARRAY_SIZE (mDevPathNodeToFromTextContext); Index++) {
    AddTestCase (DevicePathTextConversionSuite, "Test ConvertDeviceNodeToText", "TestConvertDeviceNodeToText", TestConvertDeviceNodeToText, NULL, NULL, &mDevPathNodeToFromTextContext[Index]);
  }

  for (Index = 0; Index < ARRAY_SIZE (mDevPathNodeToFromTextContext); Index++) {
    AddTestCase (DevicePathTextConversionSuite, "Test ConvertTextToDeviceNode", "TestConvertTextToDeviceNode", TestConvertTextToDeviceNode, NULL, NULL, &mDevPathNodeToFromTextContext[Index]);
  }

  for (Index = 0; Index < ARRAY_SIZE (mDevPathToFromTextContext); Index++) {
    AddTestCase (DevicePathTextConversionSuite, "Test ConvertDevicePathToText", "TestConvertDevicePathToText", TestConvertDevicePathToText, NULL, NULL, &mDevPathToFromTextContext[Index]);
  }

  for (Index = 0; Index < ARRAY_SIZE (mDevPathToFromTextContext); Index++) {
    AddTestCase (DevicePathTextConversionSuite, "Test ConvertTextToDevicePath", "TestConvertTextToDevicePath", TestConvertTextToDevicePath, NULL, NULL, &mDevPathToFromTextContext[Index]);
  }

  return EFI_SUCCESS;
}