xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Inventory/Item/Drive.interface.yaml (revision 1f7befd2490bed95e38efa75a540cbdbb9823600)
1description: >
2    Implement to provide drive attributes.
3
4properties:
5    - name: Capacity
6      default: 0
7      type: uint64
8      description: >
9          The size in bytes of the Drive. `0` if cannot be determined.
10    - name: Protocol
11      default: Unknown
12      type: enum[self.DriveProtocol]
13      description: >
14          The communication protocol used by the Drive.
15    - name: Type
16      default: Unknown
17      type: enum[self.DriveType]
18      description: >
19          The type of physical form factor of the Drive.
20    - name: EncryptionStatus
21      default: Unknown
22      type: enum[self.DriveEncryptionState]
23      description: >
24          The current state of encryption on the drive.
25    - name: LockedStatus
26      default: Unknown
27      type: enum[self.DriveLockState]
28      description: >
29          Indicates if the data on the drive is accessible. This does not
30          correspond to write locked
31    - name: PredictedMediaLifeLeftPercent
32      default: maxint
33      type: byte
34      description: >
35          How much of the drives life is remaining in a percentage from 0-100 .
36          If the reading the value is not supported returns the max value for
37          the type (255).
38    - name: Resettable
39      default: false
40      type: boolean
41      flags:
42          - readonly
43      description: >
44          This property shall indicate whether the Drive is resettable.
45
46enumerations:
47    - name: DriveProtocol
48      description: >
49          Possible communication protocol types
50      values:
51          - name: SAS
52            description: >
53                Serial Attached SCSI.
54          - name: SATA
55            description: >
56                Serial AT Attachment.
57          - name: NVMe
58            description: >
59                Non-Volatile Memory Express.
60          - name: FC
61            description: >
62                Fibre Channel.
63          - name: eMMC
64            description: >
65                Embedded MultiMediaCard
66          - name: Unknown
67            description: >
68                The Drive protocol is unknown.
69    - name: DriveType
70      description: >
71          Possible Drive type
72      values:
73          - name: HDD
74            description: >
75                A hard disk drive is an electro-mechanical data storage device
76                that stores and retrieves digital data using magnetic storage.
77          - name: SMR
78            description: >
79                The drive media type is shingled magnetic recording.
80          - name: SSD
81            description: >
82                A solid-state drive is a solid-state storage device that uses
83                integrated circuit assemblies to store data persistently.
84          - name: Unknown
85            description: >
86                The Drive type is unknown.
87    - name: DriveEncryptionState
88      description: >
89          Possible encryption states drives could have
90      values:
91          - name: Encrypted
92            description: >
93                The drive is in an encrypted state.
94          - name: Unencrypted
95            description: >
96                The drive in in an unencrypted state.
97          - name: Unknown
98            description: >
99                The encryption state of the drive is not known.
100    - name: DriveLockState
101      description: >
102          Possible lock states drives could have
103      values:
104          - name: Locked
105            description: >
106                The drive is in a locked state.
107          - name: Unlocked
108            description: >
109                The drive in in unlocked state.
110          - name: Unknown
111            description: >
112                The locked state of the drive is not known.
113