modm_data.owl.stmicro.ontology

  1# Copyright 2022, Niklas Hauser
  2# SPDX-License-Identifier: MPL-2.0
  3
  4import re
  5import owlready2 as owl
  6from .. import Store
  7
  8class KeyDict:
  9    def __init__(self, values):
 10        self.values = values
 11
 12    def __getattr__(self, attr):
 13        val = self.values.get(attr, None)
 14        if val is None:
 15            raise AttributeError("'{}' has no property '{}'".format(repr(self), attr))
 16        return val
 17
 18
 19def create_ontology(did):
 20    store = Store("stmicro", did.string)
 21    ontology = store.ontology
 22
 23    # --------------------------- DEVICE IDENTIFIER ---------------------------
 24    class DeviceIdentifier(owl.Thing):
 25        namespace = ontology
 26        comment = "The unique identifier (part number) of the device."
 27
 28    class hasDeviceSchema(owl.DataProperty, owl.FunctionalProperty):
 29        namespace = ontology
 30        comment = "How to format the device identifier."
 31        domain = [DeviceIdentifier]
 32        range = [str]
 33
 34    class hasDevicePlatform(owl.DataProperty, owl.FunctionalProperty):
 35        namespace = ontology
 36        domain = [DeviceIdentifier]
 37        range = [str]
 38
 39    class hasDeviceFamily(owl.DataProperty, owl.FunctionalProperty):
 40        namespace = ontology
 41        domain = [DeviceIdentifier]
 42        range = [str]
 43
 44    class hasDeviceName(owl.DataProperty, owl.FunctionalProperty):
 45        namespace = ontology
 46        domain = [DeviceIdentifier]
 47        range = [str]
 48
 49    class hasDevicePin(owl.DataProperty, owl.FunctionalProperty):
 50        namespace = ontology
 51        domain = [DeviceIdentifier]
 52        range = [str]
 53
 54    class hasDeviceSize(owl.DataProperty, owl.FunctionalProperty):
 55        namespace = ontology
 56        domain = [DeviceIdentifier]
 57        range = [str]
 58
 59    class hasDevicePackage(owl.DataProperty, owl.FunctionalProperty):
 60        namespace = ontology
 61        domain = [DeviceIdentifier]
 62        range = [str]
 63
 64    class hasDeviceTemperature(owl.DataProperty, owl.FunctionalProperty):
 65        namespace = ontology
 66        domain = [DeviceIdentifier]
 67        range = [str]
 68
 69    class hasDeviceVariant(owl.DataProperty, owl.FunctionalProperty):
 70        namespace = ontology
 71        domain = [DeviceIdentifier]
 72        range = [str]
 73
 74    class hasDeviceCore(owl.DataProperty, owl.FunctionalProperty):
 75        namespace = ontology
 76        domain = [DeviceIdentifier]
 77        range = [str]
 78
 79    # ------------------------------- MEMORIES --------------------------------
 80    class Memory(owl.Thing):
 81        namespace = ontology
 82        comment = "Internal memory."
 83
 84    class hasMemoryStartAddress(owl.DataProperty, owl.FunctionalProperty):
 85        namespace = ontology
 86        domain = [Memory]
 87        range = [int]
 88
 89    class hasMemorySize(owl.DataProperty, owl.FunctionalProperty):
 90        namespace = ontology
 91        domain = [Memory]
 92        range = [int]
 93
 94    class hasMemoryAccess(owl.DataProperty, owl.FunctionalProperty):
 95        namespace = ontology
 96        domain = [Memory]
 97        range = [str]
 98
 99    class hasMemory(DeviceIdentifier >> Memory):
100        namespace = ontology
101
102    # ------------------------------ INTERRUPTS -------------------------------
103    class InterruptVector(owl.Thing):
104        namespace = ontology
105        comment = "Interrupt vector in the table."
106
107    class hasInterruptVectorPosition(owl.DataProperty, owl.FunctionalProperty):
108        namespace = ontology
109        domain = [InterruptVector]
110        range = [int]
111
112    class hasInterruptVector(owl.ObjectProperty):
113        namespace = ontology
114        domain = [DeviceIdentifier]
115        range = [InterruptVector]
116
117    # --------------------------------- PINS ----------------------------------
118    class Package(owl.Thing):
119        namespace = ontology
120        comment = "A device package identifier"
121        domain = [DeviceIdentifier]
122
123    class hasPackagePinCount(owl.DataProperty, owl.FunctionalProperty):
124        namespace = ontology
125        domain = [Package]
126        range = [int]
127
128    class hasPackage(DeviceIdentifier >> Package):
129        namespace = ontology
130
131    class Pin(owl.Thing):
132        namespace = ontology
133        comment = "A pin on a package."
134
135    class hasPinType(owl.DataProperty, owl.FunctionalProperty):
136        namespace = ontology
137        domain = [Pin]
138        range = [str]
139
140    class hasPinNumber(owl.DataProperty, owl.FunctionalProperty):
141        namespace = ontology
142        domain = [Pin]
143        range = [int]
144
145    class hasPort(owl.DataProperty, owl.FunctionalProperty):
146        namespace = ontology
147        domain = [Pin]
148        range = [str]
149
150    class hasPin(owl.ObjectProperty):
151        namespace = ontology
152        domain = [Package]
153        range = [Pin]
154
155    class pinPosition(owl.AnnotationProperty):
156        namespace = ontology
157        comment = "The pin position attached to the [Package, hasPin, Pin] relation."
158
159    # -------------------------------- SIGNALS --------------------------------
160    class Signal(owl.Thing):
161        namespace = ontology
162        comment = "Connects a pin with a peripheral function."
163
164    class AlternateFunction(Signal):
165        namespace = ontology
166        comment = "Connects to a digital peripheral function via multiplexer."
167
168    class AdditionalFunction(Signal):
169        namespace = ontology
170        comment = "Connects to an analog/special peripheral function."
171
172    class hasSignal(owl.ObjectProperty):
173        namespace = ontology
174        domain = [Pin]
175        range = [Signal]
176
177    class alternateFunction(owl.AnnotationProperty):
178        namespace = ontology
179        comment = "The AF number attached to the [Pin, hasSignal, AlternateFunction] relation."
180
181    # ------------------------------ PERIPHERALS ------------------------------
182    class Peripheral(owl.Thing):
183        namespace = ontology
184        comment = "Internal peripheral."
185
186    class hasPeripheralInstance(owl.DataProperty, owl.FunctionalProperty):
187        namespace = ontology
188        domain = [Peripheral]
189        range = [int]
190
191    class hasPeripheralType(owl.DataProperty, owl.FunctionalProperty):
192        namespace = ontology
193        domain = [Peripheral]
194        range = [str]
195
196    class hasPeripheral(owl.ObjectProperty):
197        namespace = ontology
198        domain = [DeviceIdentifier, Signal]
199        range = [Peripheral]
200
201    # ----------------------------- FLASH LATENCY -----------------------------
202    class FlashWaitState(owl.Thing):
203        namespace = ontology
204        comment = "Flash Latency for minimum frequency."
205
206    class hasWaitState(owl.DataProperty, owl.FunctionalProperty):
207        namespace = ontology
208        domain = [FlashWaitState]
209        range = [int]
210
211    class hasMaxFrequency(owl.DataProperty, owl.FunctionalProperty):
212        namespace = ontology
213        domain = [FlashWaitState]
214        range = [int]
215
216    class hasMinOperatingVoltage(owl.DataProperty, owl.FunctionalProperty):
217        namespace = ontology
218        domain = [FlashWaitState]
219        range = [float]
220
221    class hasFlashWaitState(owl.ObjectProperty):
222        namespace = ontology
223        domain = [DeviceIdentifier]
224        range = [FlashWaitState]
225
226    # -------------------------------- GENERAL --------------------------------
227    class hasName(owl.DataProperty, owl.FunctionalProperty):
228        namespace = ontology
229        domain = [Memory, Signal, Peripheral, Package, Pin]
230        range = [str]
231
232    return KeyDict(locals())