Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Profile hardware - Draft Hardware Profile Submission #947

Merged
merged 141 commits into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from 134 commits
Commits
Show all changes
141 commits
Select commit Hold shift + click to select a range
75be2c5
Add Process Obect for HBOM
stevenc-stb Dec 19, 2024
b111d39
Add files via upload
stevenc-stb Dec 19, 2024
f7b92b0
Add Hardware Class Profile
stevenc-stb Dec 19, 2024
cdc9d0b
Update Hardware.md
stevenc-stb Dec 19, 2024
a9c466c
Update and rename xAxis.md to xAxisLength.md
stevenc-stb Dec 20, 2024
aee5e70
Update and rename yAxis.md to yAxisLength.md
stevenc-stb Dec 20, 2024
b6d82c6
Update and rename zAxis.md to zAxisLength.md
stevenc-stb Dec 20, 2024
6f33d08
Update HBOMDimensions.md - Change ()Axis to ()AxisLength
stevenc-stb Dec 20, 2024
4165756
Update HBOMDimensions.md Fix Capulization
stevenc-stb Dec 20, 2024
2c56078
Delete model/Hardware/Vocabularies/processType.md
stevenc-stb Dec 20, 2024
9d5191e
Add processType to Core
stevenc-stb Dec 20, 2024
131f964
Update Process.md
stevenc-stb Dec 20, 2024
f0dc396
Update and rename type.md to typeOfProcess.md
stevenc-stb Dec 20, 2024
8a0bb7e
Update Process.md
stevenc-stb Dec 21, 2024
c930806
Delete model/Hardware/Vocabularies/documentState.md
stevenc-stb Dec 21, 2024
72bfbef
Add Document State to the right place.
stevenc-stb Dec 21, 2024
3300866
Update RelationshipType.md
stevenc-stb Dec 21, 2024
47944eb
Update RelationshipType.md
stevenc-stb Dec 21, 2024
e724862
Update RelationshipType.md
stevenc-stb Dec 21, 2024
719c075
Update physical.md
stevenc-stb Dec 21, 2024
2c37e9b
Update status.md
stevenc-stb Dec 21, 2024
25ff6f6
Update RelationshipType.md
stevenc-stb Dec 21, 2024
00d0f4d
Update informationElementList.md
stevenc-stb Dec 21, 2024
b35b37c
Update physical.md
stevenc-stb Dec 21, 2024
ce6ba53
Update virtualFlag.md
stevenc-stb Dec 21, 2024
5dbf526
Update virtualFlag.md
stevenc-stb Dec 21, 2024
e1427b2
Update coordinateOrientationType.md
stevenc-stb Dec 21, 2024
89c926c
Delete model/Hardware/Vocabularies/processType.md
stevenc-stb Dec 21, 2024
6db3db4
Add files via upload
stevenc-stb Dec 21, 2024
ca45c08
Remove extra colon in informationElementList.md
bact Dec 21, 2024
2adc10b
Update model/Hardware/Classes/HBOMPhysical.md
stevenc-stb Dec 23, 2024
7cdb584
Update documentState.md
stevenc-stb Dec 23, 2024
27ce819
Rename documentState.md to DocumentState.md
stevenc-stb Dec 23, 2024
f529397
Update and rename processType.md to ProcessType.md
stevenc-stb Dec 23, 2024
d20a189
Update Process.md
stevenc-stb Dec 23, 2024
ff12907
Update coordinateOrientationType.md
stevenc-stb Dec 23, 2024
bebfaa1
Rename coordinateOrientationType.md to CoordinateOrientationType.md
stevenc-stb Dec 23, 2024
a422636
Update HBOMDimensions.md
stevenc-stb Dec 23, 2024
4e4f569
Update coordinateOrientation.md
stevenc-stb Dec 23, 2024
96a1c83
Update status.md
stevenc-stb Dec 23, 2024
e074c7d
Update model/Hardware/Classes/Hardware.md
stevenc-stb Dec 23, 2024
5d84b8c
Update model/Hardware/Classes/HBOMPhysical.md
stevenc-stb Dec 23, 2024
e74e271
Update model/Core/Vocabularies/DocumentState.md
stevenc-stb Dec 23, 2024
1be8552
Update model/Hardware/Classes/HBOMDimensions.md
stevenc-stb Dec 23, 2024
4d8790a
Update model/Core/Vocabularies/RelationshipType.md
stevenc-stb Dec 23, 2024
5857a1d
Update Hardware.md
stevenc-stb Dec 23, 2024
1182b0c
Update organizationalEntity.md
stevenc-stb Dec 23, 2024
984532c
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
stevenc-stb Dec 23, 2024
2cf3ea2
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
stevenc-stb Dec 23, 2024
b5233e1
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
stevenc-stb Dec 23, 2024
63c9dc7
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
stevenc-stb Dec 23, 2024
38749c4
Update organizationalEntity.md
stevenc-stb Dec 23, 2024
d646159
Update organizationalEntity.md
stevenc-stb Jan 7, 2025
2106dad
Update Process.md
stevenc-stb Jan 13, 2025
e30d79e
Delete model/Core/Properties/typeOfProcess.md
stevenc-stb Jan 13, 2025
7b819df
Add files via upload
stevenc-stb Jan 13, 2025
1e46cc2
Rename Action.md to Action.md
stevenc-stb Jan 13, 2025
9ae7466
Add files via upload
stevenc-stb Jan 13, 2025
0ece0ba
Update actionEndTime.md
stevenc-stb Jan 13, 2025
babe10b
Update actionStartTime.md
stevenc-stb Jan 13, 2025
3c89cbd
Update Hardware.md
stevenc-stb Jan 13, 2025
4849e6f
Update Hardware.md
stevenc-stb Jan 13, 2025
89002b4
Add files via upload
stevenc-stb Jan 13, 2025
d1a8ed8
Update InstantiatedProcess.md
stevenc-stb Jan 13, 2025
833d5cb
Update InstantiatedProcess.md
stevenc-stb Jan 13, 2025
74281a4
Update PhysicalHardware.md
stevenc-stb Jan 13, 2025
dab6200
Update PhysicalHardware.md
stevenc-stb Jan 13, 2025
3edca57
Update PhysicalHardware.md
stevenc-stb Jan 13, 2025
fc8a5cd
Update VirtualHardware.md
stevenc-stb Jan 13, 2025
7f6fa51
Update model/Core/Classes/Action.md
stevenc-stb Jan 14, 2025
a7e13d1
Update model/Core/Classes/Action.md
stevenc-stb Jan 14, 2025
524e2a1
Update model/Core/Classes/Action.md
stevenc-stb Jan 14, 2025
65a1c4c
Update model/Core/Classes/Action.md
stevenc-stb Jan 14, 2025
72b5ec6
Update model/Core/Classes/Process.md
stevenc-stb Jan 14, 2025
996dacb
Update model/Hardware/Properties/centerofMass.md
stevenc-stb Jan 14, 2025
962c430
Update model/Hardware/Properties/centerofMass.md
stevenc-stb Jan 14, 2025
71f79d5
Update model/Hardware/Vocabularies/CoordinateOrientationType.md
stevenc-stb Jan 14, 2025
72502ed
Update model/Hardware/Hardware.md
stevenc-stb Jan 14, 2025
c9f84f7
Update model/Core/Properties/actionEndTime.md
stevenc-stb Jan 14, 2025
f154c68
Update model/Hardware/Classes/HBOMPhysical.md
stevenc-stb Jan 14, 2025
0e1f9e8
Rename centerofMass.md to centerOfMass.md
stevenc-stb Jan 14, 2025
32e0518
Update model/Core/Classes/Process.md
stevenc-stb Jan 14, 2025
20ad96d
Update model/Core/Classes/Process.md
stevenc-stb Jan 14, 2025
fb64bde
Update model/Core/Classes/Process.md
stevenc-stb Jan 14, 2025
eb7bcef
Update model/Core/Properties/actionEndTime.md
stevenc-stb Jan 14, 2025
c2908ca
Update model/Core/Properties/actionEndTime.md
stevenc-stb Jan 14, 2025
af1d142
Update model/Core/Properties/actionStartTime.md
stevenc-stb Jan 14, 2025
1521a31
Apply suggestions from code review
stevenc-stb Jan 14, 2025
2e313d8
Delete model/Hardware/Properties/virtualFlag.md
stevenc-stb Jan 14, 2025
c55ed04
Apply suggestions from code review
stevenc-stb Jan 14, 2025
4036571
Delete model/Core/Vocabularies/ProcessType.md
stevenc-stb Jan 14, 2025
e4ec382
Update actionEndTime.md
stevenc-stb Jan 14, 2025
9831262
Update HBOMDimensions.md
stevenc-stb Jan 14, 2025
ba26235
Update VirtualHardware.md
stevenc-stb Jan 14, 2025
032f150
Update Hardware.md
stevenc-stb Jan 14, 2025
7e1ebd9
Update Hardware.md
stevenc-stb Jan 14, 2025
d462c9d
Update model/Hardware/Classes/HBOMPhysical.md
bact Jan 14, 2025
63cbcf9
Update physical.md
stevenc-stb Jan 14, 2025
06a91df
Apply suggestions from code review
stevenc-stb Jan 14, 2025
e08643a
Update HBOMPhysical.md
stevenc-stb Jan 14, 2025
39a3b1e
Update model/Hardware/Properties/mass.md
stevenc-stb Jan 14, 2025
6c4934c
Apply suggestions from code review
stevenc-stb Jan 14, 2025
c869ded
Update Action.md
stevenc-stb Jan 14, 2025
4839548
Update Process.md
stevenc-stb Jan 14, 2025
b52035d
Update actionEndTime.md
stevenc-stb Jan 14, 2025
a852b74
Update actionStartTime.md
stevenc-stb Jan 14, 2025
28b5f79
Update centerOfMass.md
stevenc-stb Jan 14, 2025
049eb19
Update physical.md
stevenc-stb Jan 14, 2025
8ff64b5
Remove an extra blank line in DocumentState.md
bact Jan 14, 2025
906cb31
Update VirtualHardware.md
stevenc-stb Jan 14, 2025
27c2b30
Update VirtualHardware.md
stevenc-stb Jan 14, 2025
7995374
Update model/Hardware/Classes/InstantiatedProcess.md
bact Jan 15, 2025
b7edb59
Update model/Hardware/Classes/VirtualHardware.md
bact Jan 15, 2025
288da09
Update model/Hardware/Classes/InstantiatedProcess.md
bact Jan 15, 2025
58a9394
Update model/Hardware/Classes/VirtualHardware.md
bact Jan 15, 2025
0fc7d6b
Update and rename Process.md to DefinedProcess.md
stevenc-stb Jan 21, 2025
3a44a6f
Update and rename version.md to processVersion.md
stevenc-stb Jan 21, 2025
1246e18
Update and rename status.md to processReadiness.md
stevenc-stb Jan 21, 2025
d453fcc
Update processReadiness.md
stevenc-stb Jan 21, 2025
3719d97
Update and rename DocumentState.md to ProcessReadinessType.md
stevenc-stb Jan 21, 2025
36108b6
Update rationale.md
stevenc-stb Jan 21, 2025
0c454e8
Update InstantiatedProcess.md
stevenc-stb Jan 21, 2025
ed23de3
Rename InstantiatedProcess.md to InstantiationVirtualHardwareProcess.md
stevenc-stb Jan 21, 2025
d282cb1
Update and rename version.md to hardwareVersion.md
stevenc-stb Jan 21, 2025
9daa0ba
Update Hardware.md
stevenc-stb Jan 21, 2025
0f22a7c
Update Hardware.md
stevenc-stb Jan 21, 2025
c2f80a8
Update PhysicalHardware.md
stevenc-stb Jan 21, 2025
1414da8
Update and rename HBOMPhysical.md to HBOMMass.md
stevenc-stb Jan 21, 2025
6a60dcc
Update VirtualHardware.md
stevenc-stb Jan 21, 2025
9ac9685
Add files via upload
stevenc-stb Jan 21, 2025
10d8237
Add files via upload
stevenc-stb Jan 21, 2025
a4fe7bf
Update model/Core/Classes/DefinedProcess.md
bact Jan 21, 2025
cc06d46
Update model/Hardware/Classes/Hardware.md
bact Jan 21, 2025
67d68b8
Update model/Hardware/Classes/Hardware.md
bact Jan 21, 2025
3687545
Update Hardware.md
stevenc-stb Jan 21, 2025
c81ff96
Update releaseDate.md
stevenc-stb Jan 21, 2025
ad05fe0
Update dimensions.md
stevenc-stb Jan 21, 2025
9be6aa4
Apply suggestions from code review
stevenc-stb Jan 21, 2025
640cd60
Rename VirtualHardwareModel.md to virtualHardwareModel.md
stevenc-stb Jan 21, 2025
3823315
Update VirtualHardware.md
stevenc-stb Jan 21, 2025
adb3157
Update virtualHardwareModel.md
stevenc-stb Jan 21, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions model/Core/Classes/Action.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
SPDX-License-Identifier: Community-Spec-1.0

# Action

## Summary

Class that describes an action that has occurred.

## Description

Action defines an event that has occurred. This is an Abstract Action.

## Metadata

- name: Action
- SubclassOf: Artifact
- Instantiability: Abstract

## Properties

- actionStartTime
- type: DateTime
- minCount: 0
- maxCount: 1
- actionEndTime
- type: DateTime
- minCount: 0
- maxCount: 1
32 changes: 32 additions & 0 deletions model/Core/Classes/DefinedProcess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
SPDX-License-Identifier: Community-Spec-1.0

# DefinedProcess

## Summary

Class that describes a process.

## Description

Processes are composed of systematic task(s) required to achieve a goal.

## Metadata

- name: DefinedProcess
- SubclassOf: Artifact
- Instantiability: Abstract

## Properties

- processVersion
- type: xsd:string
- minCount: 1
- maxCount: 1
- processRationale
- type: xsd:string
- minCount: 0
- maxCount: 1
- processReadiness
- type: ProcessReadinessType
- minCount: 0
- maxCount: 1
17 changes: 17 additions & 0 deletions model/Core/Properties/actionEndTime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# actionEndTime

## Summary

Property that describes the time at which an action stops.

## Description

Property describing the time at which an action stops or finishes.

## Metadata

- name: actionEndTime
- Nature: DataProperty
- Range: DateTime
17 changes: 17 additions & 0 deletions model/Core/Properties/actionStartTime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# actionStartTime

## Summary

Property describing the start time of an action.

## Description

actionStartTime is the time at which an action is triggered.

## Metadata

- name: actionStartTime
- Nature: DataProperty
- Range: DateTime
17 changes: 17 additions & 0 deletions model/Core/Properties/processReadiness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# processReadiness

## Summary

processReadiness describes the readiness of a process.

## Description

Draft, active, obsolete or other are used to define the readiness of a proceedure.

## Metadata

- name: processReadiness
- Nature: DataProperty
- Range: ProcessReadinessType
17 changes: 17 additions & 0 deletions model/Core/Properties/processVersion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# processVersion

## Summary

Defines the version of a specific process.

## Description

Defines the version of a specific process.

## Metadata

- name: processVersion
- Nature: DataProperty
- Range: xsd:string
17 changes: 17 additions & 0 deletions model/Core/Properties/rationale.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# processRationale

## Summary

The reason a process exists.

## Description

The reason a process exists.

## Metadata

- name: processRationale
- Nature: DataProperty
- Range: xsd:string
22 changes: 22 additions & 0 deletions model/Core/Vocabularies/ProcessReadinessType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
SPDX-License-Identifier: Community-Spec-1.0

# ProcessReadinessType

## Summary

The process Readiness is defined by the enumeration.

## Description

process Readiness enumerations are used to define the verson state.

## Metadata

- name: ProcessReadinessType

## Entries

- draft: in production
- active: in use
- obsolete: superseded or not valid at present
- other: other
2 changes: 2 additions & 0 deletions model/Core/Vocabularies/RelationshipType.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,15 @@ name completes the sentence:
- hasTestCase: Every `to` Element is a test case for the `from` Element (`from` hasTestCase `to`).
- hasVariant: Every `to` Element is a variant the `from` Element (`from` hasVariant `to`).
- invokedBy: The `from` Element was invoked by the `to` Agent, during a LifecycleScopeType period (for example, a Build element that describes a build step).
- instantiatedBy: The `to` Element is instantiated by the `from` Process.
- modifiedBy: The `from` Element is modified by each `to` Element.
- other: Every `to` Element is related to the `from` Element where the relationship type is not described by any of the SPDX relationship types (this relationship is directionless).
- packagedBy: Every `to` Element is a packaged instance of the `from` Element (`from` packagedBy `to`).
- patchedBy: Every `to` Element is a patch for the `from` Element (`from` patchedBy `to`).
- publishedBy: Designates a `from` Vulnerability was made available for public use or reference by each `to` Agent.
- reportedBy: Designates a `from` Vulnerability was first reported to a project, vendor, or tracking database for formal identification by each `to` Agent.
- republishedBy: Designates a `from` Vulnerability's details were tracked, aggregated, and/or enriched to improve context (i.e. NVD) by each `to` Agent.
- runsOn: The `from` Element (the instructions) of runs on each `to` Hardware (processing element), during a LifecycleScopeType period.
- serializedInArtifact: The `from` SpdxDocument can be found in a serialized form in each `to` Artifact.
- testedOn: The `from` Element has been tested on the `to` Element(s).
- trainedOn: The `from` Element has been trained on the `to` Element(s).
Expand Down
39 changes: 39 additions & 0 deletions model/Hardware/Classes/HBOMDimensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
SPDX-License-Identifier: Community-Spec-1.0

# HBOMDimensions
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this a separate class instead of these being properties of HBOMPhysical ?
And what does HBOM mean, anyway?


## Summary

Class that describes a instance of HBOMDimensions.

## Description

This class records the unit dimensions.

## Metadata

- name: HBOMDimensions
- Instantiability: Concrete

## Properties

- xAxisLength
- type: xsd:string
- minCount: 1
- maxCount: 1
- yAxisLength
- type: xsd:string
- minCount: 1
- maxCount: 1
- zAxisLength
- type: xsd:string
- minCount: 1
- maxCount: 1
- dimensionsUnit
- type: xsd:string
- minCount: 1
- maxCount: 1
- coordinateOrientation
- type: CoordinateOrientationType
- minCount: 1
- maxCount: 1
25 changes: 25 additions & 0 deletions model/Hardware/Classes/HBOMMass.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
SPDX-License-Identifier: Community-Spec-1.0

# HBOMMass

## Summary

Class that describes a instance of HBOMPhysical.

## Description

Describes the physical mass characteristics of hardware.

## Metadata

- name: HBOMMass
- Instantiability: Concrete

## Properties

- mass
- type: xsd:decimal
- maxCount: 1
- massUnit
- type: xsd:string
- maxCount: 1
42 changes: 42 additions & 0 deletions model/Hardware/Classes/Hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
SPDX-License-Identifier: Community-Spec-1.0

# Hardware

## Summary

Class that describes an instance of Hardware.

## Description

A hardware artifact is a distinct unit related to hardware.

## Metadata

- name: Hardware
- SubclassOf: /Core/Element
- Instantiability: Abstract

## Properties

- organizationalEntity
- type: /Core/Organization
- minCount: 1
- maxCount: 1
- hardwareVersion
- type: xsd:string
- maxCount: 1
- partNumber
- type: xsd:string
- minCount: 1
- maxCount: 1
- releaseDate
- type: /Core/DateTime
- maxCount: 1
- serialNumber
- type: xsd:string
- maxCount: 1
- batchNumber
- type: xsd:string
- maxCount: 1
- informationElementList
- type: /Core/DictionaryEntry
18 changes: 18 additions & 0 deletions model/Hardware/Classes/InstantiationVirtualHardwareProcess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
SPDX-License-Identifier: Community-Spec-1.0

# InstantiationVirtualHardwareProcess

## Summary

Class that describes an InstantiationVirtualHardwareProcess that is used to define VirtualHardware and its source.

## Description

InstantiationVirtualHardwareProcess is a class defining the process needed to instantiate an 'VirtualHardware' defined by running software package(s).

## Metadata

- name: InstantiationVirtualHardwareProcess
- SubclassOf: /Core/DefinedProcess
- Instantiability: Concrete

30 changes: 30 additions & 0 deletions model/Hardware/Classes/PhysicalHardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
SPDX-License-Identifier: Community-Spec-1.0

# PhysicalHardware
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference between PhysicalHardware and HBOMPhysical ?


## Summary

Class that describes a physical instance of Hardware.

## Description

A PhysicalHardware artifact describes a distinct physical unit.

## Metadata

- name: PhysicalHardware
- SubclassOf: Hardware
- Instantiability: Concrete

## Properties

- massOfHardware
- type: HBOMMass
- minCount: 0
- maxCount: 1
- dimensions
- type: HBOMDimensions
- maxCount: 1
- centerOfMass
- type: HBOMDimensions
- maxCount: 1
27 changes: 27 additions & 0 deletions model/Hardware/Classes/VirtualHardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
SPDX-License-Identifier: Community-Spec-1.0

# VirtualHardware

## Summary

Class that describes an instance of VirtualHardware.

## Description

A VirtualHardware is a distinct article related to simulation or emulation hardware.
This is used to assist in recording "Digital Twinning".
A FPGA simualtion of hardware is a VirtualHardware.
Virtual hardware requires instantiation involving specific hardware and software.

## Metadata

- name: VirtualHardware
- SubclassOf: Hardware
- Instantiability: Concrete

## Properties
bact marked this conversation as resolved.
Show resolved Hide resolved

bact marked this conversation as resolved.
Show resolved Hide resolved
- VirtualHardwareModel
- type: VirtualHardwareModelType
- minCount: 0
- maxCount: 1
Loading
Loading