aboutsummaryrefslogtreecommitdiffstats
path: root/misc/jny.schema.json
blob: 0fff8ee57d86fd3378e6a6c3ba33ca5570c43ead (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
{
	"$schema": "https://json-schema.org/draft/2020-12/schema",
	"$id": "https://raw.githubusercontent.com/YosysHQ/yosys/master/misc/jny.schema.json",
	"title": "Yosys JSON Netlist metadata",
	"description": "Yosys JSON Netlist",
	"type": "object",
	"properties": {
		"generator": {
			"type": "string",
			"description": "JNY File Generator"
		},
		"version": {
			"type": "string",
			"description": "JNY Version"
		},
		"invocation": {
			"type": "string",
			"description": "Invocation line that generated the JNY metadata"
		},
		"features": {
			"type": "array",
			"description": "What information is contained in the JNY file",
			"items": {
				"type": "string"
			}
		},
		"modules": {
			"type": "array",
			"items": { "$ref": "#/$defs/module" }
		}
	},
	"required": [
		"generator",
		"version",
		"invocation",
		"features"
	],
	"$defs": {
		"module": {
			"type": "object",
			"description": "Module definition",
			"properties": {
				"name": {
					"type": "string",
					"description": "Module Name"
				},
				"cell_sorts": {
					"type": "array",
					"description": "",
					"items": { "$ref": "#/$defs/cell_sort" }
				},
				"connections": {
					"type": "array",
					"description": "Cell connections",
					"items": { "$ref": "#/$defs/connection" }
				},
				"attributes": {
					"type": "object",
					"description": "Attributes attached to the module"
				},
				"parameters": {
					"type": "object",
					"description": "Parameters attached to the module"
				}
			},
			"required": [
				"name",
				"cell_sorts"
			]
		},
		"cell_sort": {
			"type": "object",
			"description": "Describes a type of cell",
			"properties": {
				"type": {
					"type": "string",
					"description": "Type of cell"
				},
				"ports": {
					"type": "array",
					"description": "Cell ports",
					"items": { "$ref": "#/$defs/port" }
				}
				,
				"cells": {
					"type": "array",
					"description": "Cells of cell_sort",
					"items": { "$ref": "#/$defs/cell" }
				}
			},
			"required": [
				"type",
				"ports",
				"cells"
			]
		},
		"connection": {
			"type": "object",
			"description": "A connection within a module or cell",
			"properties": {
				"name": {
					"type": "string",
					"description": "Connection name"
				},
				"signals": {
					"type": "array",
					"description": "Signals that compose the connection",
					"items": { "$ref": "#/$defs/signal" }
				}
			},
			"required": [
				"name",
				"signals"
			]
		},
		"port": {
			"type": "object",
			"description": "Cell port description",
			"properties": {
				"name": {
					"type": "string",
					"description": "Port name"
				},
				"direction": {
					"type": "string",
					"description": "Port direction",
					"enum": ["i", "o", "io", ""]
				},
				"range": {
					"type": "array",
					"description": "Port width [MSB, LSB]",
					"items": {
					  "type": "number"
					},
					"minContains": 1,
					"maxContains": 2
				}
			},
			"required": [
				"name",
				"direction",
				"range"
			]
		},
		"cell": {
			"type": "object",
			"description": "Module cell definition",
			"properties": {
				"name": {
					"type": "string",
					"description": "Cell name"
				},
				"connections": {
					"type": "array",
					"description": "Cell connections",
					"items": { "$ref": "#/$defs/connection" }
				},
				"attributes": {
					"type": "object",
					"description": "Attributes attached to the cell"
				},
				"parameters": {
					"type": "object",
					"description": "Parameters attached to the cell"
				}
			},
			"required": [
				"name"
			]
		},
		"signal": {
			"type": "object",
			"description": "A signal definition",
			"parameters": {
				"width": {
					"type": "string"
				},
				"type": {
					"type": "string",
					"enum": ["wire", "chunk"]
				},
				"const": {
					"type": "boolean"
				}
			},
			"required": [
				"width",
				"type",
				"const"
			]
		}
	}
}