summaryrefslogtreecommitdiff
path: root/DynamicTablesPkg/Library/FdtHwInfoParserLib/Gic/ArmGicDispatcher.c
blob: 1f3af1f968a9f85998a9aa4f6c317ddee0840b89 (plain)
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
/** @file
  Arm Gic dispatcher.

  Copyright (c) 2021, ARM Limited. All rights reserved.<BR>
  SPDX-License-Identifier: BSD-2-Clause-Patent

  @par Reference(s):
  - linux/Documentation/devicetree/bindings/interrupt-controller/arm,gic.yaml
  - linux/Documentation/devicetree/bindings/interrupt-controller/arm,gic-v3.yaml
**/

#include "FdtHwInfoParser.h"
#include "Gic/ArmGicCParser.h"
#include "Gic/ArmGicDispatcher.h"
#include "Gic/ArmGicDParser.h"
#include "Gic/ArmGicItsParser.h"
#include "Gic/ArmGicMsiFrameParser.h"
#include "Gic/ArmGicRParser.h"

/** List of "compatible" property values for GicV2 interrupt nodes.

  Any other "compatible" value is not supported by this module.
*/
STATIC CONST COMPATIBILITY_STR  GicV2CompatibleStr[] = {
  { "arm,cortex-a15-gic" }
};

/** COMPATIBILITY_INFO structure for the GICv2.
*/
CONST COMPATIBILITY_INFO  GicV2CompatibleInfo = {
  ARRAY_SIZE (GicV2CompatibleStr),
  GicV2CompatibleStr
};

/** List of "compatible" property values for GicV3 interrupt nodes.

  Any other "compatible" value is not supported by this module.
*/
STATIC CONST COMPATIBILITY_STR  GicV3CompatibleStr[] = {
  { "arm,gic-v3" }
};

/** COMPATIBILITY_INFO structure for the GICv3.
*/
CONST COMPATIBILITY_INFO  GicV3CompatibleInfo = {
  ARRAY_SIZE (GicV3CompatibleStr),
  GicV3CompatibleStr
};

/** Get the Gic version of am interrupt-controller node.

  @param [in]  Fdt          Pointer to a Flattened Device Tree (Fdt).
  @param [in]  IntcNode     Interrupt-controller node.
  @param [out] GicVersion   If success, contains the Gic version of the
                            interrupt-controller node.

  @retval EFI_SUCCESS             The function completed successfully.
  @retval EFI_INVALID_PARAMETER   Invalid parameter.
  @retval EFI_UNSUPPORTED         Unsupported.
**/
EFI_STATUS
EFIAPI
GetGicVersion (
  IN  CONST VOID    *Fdt,
  IN        INT32   IntcNode,
  OUT       UINT32  *GicVersion
  )
{
  if ((Fdt == NULL) ||
      (GicVersion == NULL))
  {
    ASSERT (0);
    return EFI_INVALID_PARAMETER;
  }

  if (FdtNodeIsCompatible (Fdt, IntcNode, &GicV2CompatibleInfo)) {
    *GicVersion = 2;
  } else if (FdtNodeIsCompatible (Fdt, IntcNode, &GicV3CompatibleInfo)) {
    *GicVersion = 3;
  } else {
    // Unsupported Gic version.
    ASSERT (0);
    return EFI_UNSUPPORTED;
  }

  return EFI_SUCCESS;
}

/** Gic dispatcher.

  This disptacher populates the following structures:
   - CM_ARM_GICC_INFO
   - CM_ARM_GICD_INFO
   - CM_ARM_GIC_MSI_FRAME_INFO

  A parser parses a Device Tree to populate a specific CmObj type. None,
  one or many CmObj can be created by the parser.
  The created CmObj are then handed to the parser's caller through the
  HW_INFO_ADD_OBJECT interface.
  This can also be a dispatcher. I.e. a function that not parsing a
  Device Tree but calling other parsers.

  @param [in]  FdtParserHandle A handle to the parser instance.
  @param [in]  FdtBranch       When searching for DT node name, restrict
                               the search to this Device Tree branch.

  @retval EFI_SUCCESS             The function completed successfully.
  @retval EFI_ABORTED             An error occurred.
  @retval EFI_INVALID_PARAMETER   Invalid parameter.
  @retval EFI_NOT_FOUND           Not found.
  @retval EFI_UNSUPPORTED         Unsupported.
**/
EFI_STATUS
EFIAPI
ArmGicDispatcher (
  IN  CONST FDT_HW_INFO_PARSER_HANDLE  FdtParserHandle,
  IN        INT32                      FdtBranch
  )
{
  EFI_STATUS  Status;
  INT32       CpusNode;
  INT32       IntcNode;
  UINT32      GicVersion;
  VOID        *Fdt;

  if (FdtParserHandle == NULL) {
    ASSERT (0);
    return EFI_INVALID_PARAMETER;
  }

  Fdt = FdtParserHandle->Fdt;

  // The "cpus" node resides at the root of the DT. Fetch it.
  CpusNode = fdt_path_offset (Fdt, "/cpus");
  if (CpusNode < 0) {
    return EFI_NOT_FOUND;
  }

  // Get the interrupt-controller node associated to the "cpus" node.
  Status = FdtGetIntcParentNode (Fdt, CpusNode, &IntcNode);
  if (EFI_ERROR (Status)) {
    ASSERT (0);
    if (Status == EFI_NOT_FOUND) {
      // Should have found the node.
      Status = EFI_ABORTED;
    }

    return Status;
  }

  Status = GetGicVersion (Fdt, IntcNode, &GicVersion);
  if (EFI_ERROR (Status)) {
    ASSERT (0);
    return Status;
  }

  // Parse the GicC information.
  Status = ArmGicCInfoParser (FdtParserHandle, CpusNode);
  if (EFI_ERROR (Status)) {
    // Don't try to parse GicD and GicMsiFrame information
    // if no GicC information is found. Return.
    ASSERT (Status == EFI_NOT_FOUND);
    return Status;
  }

  // Parse the GicD information of the "cpus" interrupt-controller node.
  Status = ArmGicDInfoParser (FdtParserHandle, IntcNode);
  if (EFI_ERROR (Status)) {
    // EFI_NOT_FOUND is not tolerated at this point.
    ASSERT (0);
    return Status;
  }

  switch (GicVersion) {
    case 4:
    case 3:
    {
      // Parse the GicR information of the interrupt-controller node.
      Status = ArmGicRInfoParser (FdtParserHandle, IntcNode);
      if (EFI_ERROR (Status)) {
        // EFI_NOT_FOUND is not tolerated at this point.
        ASSERT (0);
        return Status;
      }

      // Parse the GicIts information of the interrupt-controller node.
      Status = ArmGicItsInfoParser (FdtParserHandle, IntcNode);
      if (EFI_ERROR (Status)  &&
          (Status != EFI_NOT_FOUND))
      {
        ASSERT (0);
        return Status;
      }

      break;
    }
    case 2:
    {
      // Parse the GicMsiFrame information.
      Status = ArmGicMsiFrameInfoParser (FdtParserHandle, IntcNode);
      if (EFI_ERROR (Status)  &&
          (Status != EFI_NOT_FOUND))
      {
        ASSERT (0);
        return Status;
      }

      break;
    }
    default:
    {
      ASSERT (0);
      return EFI_UNSUPPORTED;
    }
  }

  return EFI_SUCCESS;
}