Static power calculation (#77)

Author: chernyee

backend/api/device.py

@@ -2,42 +2,85 @@
 #  Copyright (C) 2024 RapidSilicon
 #  Authorized use only
 #
-from flask import Blueprint
+from flask import Blueprint, request
 from flask_restful import Api, Resource
-from marshmallow import Schema, fields
+from marshmallow import Schema, fields, ValidationError
 from submodule.rs_device_manager import RsDeviceManager
 from submodule.rs_device_resources import DeviceNotFoundException
 from submodule.rs_message import RsMessageType
-from .errors import DeviceNotExistsError, InternalServerError
+from .errors import DeviceNotExistsError, InternalServerError, SchemaValidationError
 from .errors import errors
 
 #---------------------------------------------------------------------------#
 # endpoints                       | methods         | classes               #
 #---------------------------------------------------------------------------# 
 # devices                         | get             | DevicesApi            #
-# devices/<device_id>             | get             | DeviceApi             #
+# devices/<device_id>             | get, patch      | DeviceApi             #
 # devices/<device_id>/consumption | get             | DeviceConsumptionApi  #
 #---------------------------------------------------------------------------#
 
 class MessageSchema(Schema):
     type = fields.Enum(RsMessageType, by_value=True)
     text = fields.Str()
 
+class AmbientSchema(Schema):
+    typical = fields.Number()
+    worsecase = fields.Number()
+
+class ThermalSpecSchema(Schema):
+    theta_ja = fields.Number()
+    ambient = fields.Nested(AmbientSchema)
+
+class TypicalDynamicScalingSchema(Schema):
+    fpga_complex = fields.Number()
+    processing_complex = fields.Number()
+
+class PowerSpecSchema(Schema):
+    budget = fields.Number()
+    typical_dynamic_scaling = fields.Nested(TypicalDynamicScalingSchema)
+
+class SpecificationSchema(Schema):
+    thermal = fields.Nested(ThermalSpecSchema)
+    power = fields.Nested(PowerSpecSchema)
+
 class DeviceSchema(Schema):
     id = fields.Str()
     series = fields.Str()
     logic_density = fields.Str()
     package = fields.Str()
     speedgrade = fields.Str()
     temperature_grade = fields.Str()
+    specification = fields.Nested(SpecificationSchema)
 
-class DevicePowerThermalSchema(Schema):
-    total_power = fields.Number()
-    thermal = fields.Number()
+class DeviceTotalPowerTemperatureSchema(Schema):
+    type = fields.Str()
+    power = fields.Number()
+    temperature = fields.Number()
+
+class DeviceComponentSchema(Schema):
+    type = fields.Str()
+    power = fields.Number()
+    percentage = fields.Number()
+
+class DeviceDynamicSchema(Schema):
+    components = fields.Nested(DeviceComponentSchema, many=True)
+    power = fields.Number()
+    percentage = fields.Number()
+
+class DeviceStaticSchema(Schema):
+    power = fields.Number()
+    percentage = fields.Number()
+
+class DeviceComplexSchema(Schema):
+    dynamic = fields.Nested(DeviceDynamicSchema)
+    static = fields.Nested(DeviceStaticSchema)
+    total_power = fields.Number(default=0.0)
+    total_percentage = fields.Number(default=0.0)
 
 class DeviceConsumptionSchema(Schema):
-    worsecase = fields.Nested(DevicePowerThermalSchema)
-    typical = fields.Nested(DevicePowerThermalSchema)
+    total_power_temperature = fields.Nested(DeviceTotalPowerTemperatureSchema, many=True)
+    processing_complex = fields.Nested(DeviceComplexSchema)
+    fpga_complex = fields.Nested(DeviceComplexSchema)
 
 class DevicesApi(Resource):
     def get(self):
@@ -89,20 +132,102 @@ def get(self):
                         type: string
                     temperature_grade:
                         type: string
-            DevicePowerThermal:
+            DeviceTotalPowerTemperature:
+                type: object
+                properties:
+                    type:
+                        type: string
+                    power:
+                        type: number
+                    temperature:
+                        type: number
+            DeviceComponent:
+                type: object
+                properties:
+                    type:
+                        type: string
+                    power:
+                        type: number
+                    percentage:
+                        type: number
+            DeviceDynamic:
+                type: object
+                properties:
+                    components:
+                        type: array
+                        items:
+                            $ref: '#/definitions/DeviceComponent'
+                    power:
+                        type: number
+                    percentage:
+                        type: number
+            DeviceStatic:
                 type: object
                 properties:
+                    power:
+                        type: number
+                    percentage:
+                        type: number
+            DeviceComplex:
+                type: object
+                properties:
+                    dynamic:
+                        $ref: '#/definitions/DeviceDynamic'
+                    static:
+                        $ref: '#/definitions/DeviceStatic'
                     total_power:
                         type: number
-                    thermal:
+                    total_percentage:
                         type: number
             DeviceConsumption:
                 type: object
                 properties:
-                    worsecase:
-                        $ref: '#/definitions/DevicePowerThermal'
+                    total_power_temperature:
+                        type: array
+                        items:
+                            $ref: '#/definitions/DeviceTotalPowerTemperature'
+                    processing_complex:
+                        $ref: '#/definitions/DeviceComplex'
+                    fpga_complex:
+                        $ref: '#/definitions/DeviceComplex'
+            Ambient:
+                type: object
+                properties:
                     typical:
-                        $ref: '#/definitions/DevicePowerThermal'
+                        type: number
+                    worsecase:
+                        type: number
+            TypicalDynamicScaling:
+                type: object
+                properties:
+                    fpga_complex:
+                        type: number
+                    processing_complex:
+                        type: number
+            Thermal:
+                type: object
+                properties:
+                    theta_ja:
+                        type: number
+                    ambient:
+                        $ref: '#/definitions/Ambient'
+            Power:
+                type: object
+                properties:
+                    budget:
+                        type: number
+                    typical_dynamic_scaling:
+                        $ref: '#/definitions/TypicalDynamicScaling'
+            Specification:
+                type: object
+                properties:
+                    specification:
+                        type: object
+                        properties:
+                            thermal:
+                                $ref: '#/definitions/Thermal'
+                            power:
+                                $ref: '#/definitions/Power'
         responses:
             200:
                 description: Successfully returned a list of devices
@@ -135,7 +260,9 @@ def get(self, device_id : str):
             200:
                 description: Successfully returned the details of a device
                 schema:
-                    $ref: '#/definitions/Device'
+                    allOf:
+                        - $ref: '#/definitions/Device'
+                        - $ref: '#/definitions/Specification'
             400:
                 description: Invalid request
                 schema:
@@ -151,6 +278,48 @@ def get(self, device_id : str):
         except Exception as e:
            raise InternalServerError
 
+    def patch(self, device_id : str):
+        """
+        This is an endpoint that updates the power and thermal spec of a device
+        ---
+        tags:
+            - Device
+        description: Update the power and thermal spec of a device.
+        parameters:
+            - name: device_id
+              in: path
+              type: string
+              required: true
+            - name: spec
+              in: body
+              description: Update the power and thermal spec of a device
+              schema:
+                $ref: '#/definitions/Specification'
+        responses:
+            200:
+                description: Successfully updated the power and thermal spec
+                schema:
+                    allOf:
+                        - $ref: '#/definitions/Device'
+                        - $ref: '#/definitions/Specification'
+            400:
+                description: Invalid request
+                schema:
+                    $ref: '#/definitions/HTTPErrorMessage'
+        """
+        try:
+            device_mgr = RsDeviceManager.get_instance()
+            device = device_mgr.get_device(device_id)
+            schema = DeviceSchema()
+            device.update_spec(schema.load(request.json))
+            return schema.dump(device), 200
+        except ValidationError as e:
+            raise SchemaValidationError
+        except DeviceNotFoundException as e:
+           raise DeviceNotExistsError
+        except Exception as e:
+           raise InternalServerError
+
 class DeviceConsumptionApi(Resource):
     def get(self, device_id : str):
         """

backend/api/io.py

@@ -34,7 +34,7 @@ class IoUsageAllocationSchema(Schema):
     io_available = fields.Int()
 
 class IoUsageSchema(Schema):
-    type = fields.Str()
+    type = fields.Enum(IO_Bank_Type, by_value=True)
     total_banks_available = fields.Int()
     total_io_available = fields.Int()
     usage = fields.Nested(IoUsageAllocationSchema, many=True)

backend/submodule/bram.py

@@ -194,6 +194,9 @@ def get_resources(self):
                 total_36k_bram_used += item.bram_used
         return total_18k_bram_used, self.total_18k_bram_available, total_36k_bram_used, self.total_36k_bram_available
 
+    def get_total_output_power(self) -> float:
+        return sum(self.get_power_consumption())
+
     def get_power_consumption(self):
         return self.total_block_power, self.total_interconnect_power
 

backend/submodule/clock.py

@@ -74,6 +74,9 @@ def __init__(self, resources, itemlist):
         self.total_pll_power = 0.0
         self.itemlist = itemlist
 
+    def get_total_output_power(self) -> float:
+        return sum(self.get_power_consumption())
+
     def get_power_consumption(self):
         return self.total_block_power, self.total_interconnect_power, self.total_pll_power
 

backend/submodule/dsp.py

@@ -117,6 +117,9 @@ def get_resources(self):
                 total_dsp_blocks_used += item.number_of_multipliers
         return total_dsp_blocks_used, self.total_dsp_blocks_available
 
+    def get_total_output_power(self) -> float:
+        return sum(self.get_power_consumption())
+
     def get_power_consumption(self):
         return self.total_block_power, self.total_interconnect_power
 

backend/submodule/fabric_logic_element.py

@@ -99,6 +99,9 @@ def __init__(self, resources, itemlist):
         self.total_interconnect_power = 0.0
         self.itemlist = itemlist
 
+    def get_total_output_power(self) -> float:
+        return sum(self.get_power_consumption())
+
     def get_power_consumption(self):
         return self.total_block_power, self.total_interconnect_power
 

backend/submodule/io.py

@@ -165,7 +165,7 @@ class IO_Usage_Allocation:
 
 @dataclass
 class IO_Usage:
-    type : str = field(default='')
+    type : IO_Bank_Type = field(default=IO_Bank_Type.HP)
     total_banks_available : int = field(default=0)
     total_io_available : int = field(default=0)
     usage : List[IO_Usage_Allocation] = field(default_factory=list)
@@ -184,8 +184,8 @@ def __init__(self, resources, itemlist):
         self.total_interconnect_power = 0.0
         self.total_on_die_termination_power = 0.0
         self.io_usage = [
-            IO_Usage(type="HP", usage=[IO_Usage_Allocation(voltage=1.2), IO_Usage_Allocation(voltage=1.5), IO_Usage_Allocation(voltage=1.8)]),
-            IO_Usage(type="HR", usage=[IO_Usage_Allocation(voltage=1.8), IO_Usage_Allocation(voltage=2.5), IO_Usage_Allocation(voltage=3.3)])
+            IO_Usage(type=IO_Bank_Type.HP, usage=[IO_Usage_Allocation(voltage=1.2, banks_used=1), IO_Usage_Allocation(voltage=1.5, banks_used=1), IO_Usage_Allocation(voltage=1.8, banks_used=1)]),
+            IO_Usage(type=IO_Bank_Type.HR, usage=[IO_Usage_Allocation(voltage=1.8, banks_used=1), IO_Usage_Allocation(voltage=2.5, banks_used=1), IO_Usage_Allocation(voltage=3.3, banks_used=1)])
         ]
         self.io_on_die_termination = [
             IO_On_Die_Termination(bank_number=1),
@@ -197,6 +197,9 @@ def __init__(self, resources, itemlist):
     def get_resources(self):
         return self.io_usage, self.io_on_die_termination
 
+    def get_total_output_power(self) -> float:
+        return sum(self.get_power_consumption())
+
     def get_power_consumption(self):
         return self.total_block_power, self.total_interconnect_power, self.total_on_die_termination_power
 

backend/submodule/peripherals.py

@@ -401,6 +401,30 @@ def __init__(self, resources):
             Fpga_Complex(name="FPGA Complex", ports=[Endpoint(), Endpoint(), Endpoint(), Endpoint()])
         ]
 
+    def get_processor_output_power(self) -> float:
+        # todo
+        return 0.347
+
+    def get_peripherals_output_power(self) -> float:
+        # todo
+        return 0.024
+
+    def get_bcpu_output_power(self) -> float:
+        # todo
+        return 0.013
+
+    def get_memory_output_power(self) -> float:
+        # todo
+        return 0.001
+
+    def get_dma_output_power(self) -> float:
+        # todo
+        return 0.0001
+
+    def get_noc_output_power(self) -> float:
+        # todo
+        return 0.003
+
     def get_power_consumption(self):
         # todo
         return 0.347, 0.024, 0.013, 0.001, 0.0001, 0.003