bmputil 1.0.0-rc.1

Black Magic Probe Firmware Manager
Documentation 
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

{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "https://github.com/blackmagic-debug/bmputil/src/metadata/metadata.schema.json",
	"title": "Black Magic Debug releases index metadata",
	"type": "object",
	"properties":
	{
		"version":
		{
			"const": 1,
			"desciption": "Version number the metadata file conforms to"
		},
		"releases":
		{
			"type": "object",
			"desciption": "Available releases from the index",
			"patternProperties":
			{
				"^v[0-9]+\\.[0-9]+\\.[0-9]+(-rc[0-9]+)?$":
				{
					"$ref": "#/$defs/release"
				}
			}
		}
	},
	"required": ["version", "releases"],
	"$defs": {
		"release":
		{
			"type": "object",
			"desciption": "The description of a specific release of Black Magic Debug",
			"properties":
			{
				"includesBMDA":
				{
					"type": "boolean",
					"desciption": "Whether the release includes BMDA binaries"
				},
				"firmware":
				{
					"type": "object",
					"desciption": "Firmware by probe platform available in the release",
					"propertyNames":
					{
						"enum":
						[
							"96b_carbon",
							"blackpill-f401cc",
							"blackpill-f401ce",
							"blackpill-f411ce",
							"bluepill",
							"ctxlink",
							"f072",
							"f3",
							"f4discovery",
							"hydrabus",
							"launchpad-icdi",
							"native",
							"stlink",
							"stlinkv3",
							"swlink"
						]
					},
					"additionalProperties": {"$ref": "#/$defs/firmware"}
				}
			},
			"required": ["includesBMDA", "firmware"],
			"if": {"properties": {"includesBMDA": {"const": true}}},
			"then":
			{
				"properties": {"bmda": {"$ref": "#/$defs/bmda"}},
				"required": ["bmda"]
			}
		},
		"firmware":
		{
			"type": "object",
			"desciption": "Firmware available for a specific probe",
			"patternProperties":
			{
				"^.+$":
				{
					"type": "object",
					"desciption": "Description of a specific firmware download",
					"properties":
					{
						"friendlyName":
						{
							"type": "string",
							"desciption": "Name displayed in the interface for this firmware object"
						},
						"fileName":
						{
							"type": "string",
							"desciption": "Local file name for the firmware to be written into",
							"pattern": "^blackmagic-[a-z0-9_]+(-.+)?-v[0-9]+_[0-9]+_[0-9]+(-rc[0-9]+)?\\.(elf|bin)$"
						},
						"uri":
						{
							"type": "string",
							"desciption": "Universal Resource Indicator for where to download this firmware object from",
							"format": "uri"
						}
					},
					"required": ["friendlyName", "fileName", "uri"]
				}
			}
		},
		"bmda":
		{
			"type": "object",
			"desciption": "Available builds of BMDA by host platform",
			"propertyNames":
			{
				"enum":
				[
					"linux",
					"macos",
					"windows"
				]
			},
			"additionalProperties":
			{
				"desciption": "Operating system on which the BMDA builds can be run",
				"$ref": "#/$defs/bmda-arch"
			}
		},
		"bmda-arch":
		{
			"type": "object",
			"propertyNames":
			{
				"enum":
				[
					"i386",
					"amd64",
					"aarch32",
					"aarch64"
				]
			},
			"additionalProperties":
			{
				"type": "object",
				"desciption": "Description of a specific BMDA download",
				"properties":
				{
					"fileName":
					{
						"type": "string",
						"desciption": "Name of the file within the asset archive to unpack for execution as BMDA"
					},
					"uri":
					{
						"type": "string",
						"desciption": "Universal Resource Indicator for where to download this BMDA archive from",
						"format": "uri"
					}
				},
				"required": ["fileName", "uri"]
			}
		}
	}
}