summaryrefslogtreecommitdiff
path: root/xyz/openbmc_project/Smbios/MDR_V1.interface.yaml
blob: 5b46ebfb92cad8a90e5fd38f5bbe09ba8e6430a1 (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
description: >
    smbios MDR V1 service
methods:
    - name: RegionStatus
      description: >
          Get the region status with the given region ID
      parameters:
        - name: regionId
          type: byte
          description: >
              region ID of Regions.
      returns:
        - name: status
          type: array[byte]
          description: >
            The result of region status.
      errors:
       - self.Error.InvalidParameter

    - name: RegionComplete
      description: >
          Set complete status to region
      parameters:
        - name: regionId
          type: byte
          description:
              region ID of Regions.
      errors:
       - self.Error.InvalidParameter
       - self.Error.IOError

    - name: RegionRead
      description: >
          Read Region Data from BMC Memory
      parameters:
        - name: regionId
          type: byte
          description: >
              region ID of Regions.
        - name: length
          type: byte
          description: >
              length of read data
        - name: offset
          type: uint16
          description: >
              offset of read data
      returns:
        - name: regionData
          type: array[byte]
          description: >
              region data user want to read.
      errors:
       - self.Error.InvalidParameter

    - name: RegionWrite
      description: >
          Write Region Data to BMC Memory
      parameters:
        - name: regionData
          type: array[byte]
          description: >
              Data need to write to memory
      returns:
        - name: status
          type: string
          description: >
              The status of the write function
      errors:
       - self.Error.InvalidParameter

    - name: RegionLock
      description: >
          Lock Region
      parameters:
        - name: sessionId
          type: byte
          description: >
              Session ID
        - name: regionId
          type: byte
          description: >
              Region ID
        - name: lockPolicy
          type: byte
          description: >
              The policy to lock region
        - name: timeout
          type: uint16
          description: >
              Timeout when try to lock region
      returns:
        - name: returnSessionId
          type: byte
          description: >
              return the lock session ID
      errors:
       - self.Error.InvalidParameter

properties:
    - name: RegionId
      type: byte
      description: >
          ID of Region
    - name: SessionId
      type: byte
      description: >
          ID of session
    - name: LockPolicy
      type: byte
      description: >
          The policy of the lock
    - name: RegionUsed
      type: uint16
      description: >
          If the region is used or not