SensorHub.idl

/* SPDX-License-Identifier: BSD-3-Clause */
/*
 * Copyright 2020 Raritan Inc. All rights reserved.
 */
 
#ifndef __PERIPHERAL_SENSORHUB_IDL__
#define __PERIPHERAL_SENSORHUB_IDL__
 
#include <UserEvent.idl>
#include <PortFuse.idl>
#include <PeripheralDevicePackage.idl>
#include <PeripheralDeviceSlot.idl>
 
/**
 * Peripheral Devices
 */
module peripheral {
 
    /** Sensor Hub interface */
    interface SensorHub {
 
        /** peripheral device hw configuration  */
        enumeration UpstreamType {
            BUILTIN,    ///< a built in hardware
            ENV_HUB,    ///< a not galvanically isolated environmental hub with reduced fuse capability
            REMOTE_HUB  ///< a galvanically isolated remote hub with full fuse capability
        };
 
        /**
         * Information for a single hub Port
         */
        structure HubPortInfo {
            string hubPort;                     ///< Sensor hub port a peripheral device is connected to
            portsmodel.PortFuse fuse;     ///< Reference to the port fuse
        };
 
        /**
         * Static (type, version) information for a %SensorHub.
         */
        structure DeviceInfo {
            string serial;                      ///< Serial number of device
            string model;                       ///< Model name of device
            UpstreamType upstreamType;          ///< Hardware type (indicated a certain upstream type)
            PosElement position;          ///< Peripheral device position element, list forms position
            int protocolVersion;                ///< Protocol version the hub is supporting
            int bootVersion;                    ///< Bootcode software version
            int appVersion;                     ///< Application code software version
            vector<HubPortInfo> hubPortInfos;   ///< Information about contained hub ports
        };
 
        /**
         * Get static (hardware and firmware) information
         *
         * @return Result: hardware and firmware information
         */
        DeviceInfo getDeviceInfo();
 
        /**
         * Retrieve hub package information
         *
         * @return package information
         */
        PackageInfo getPackageInfo();
    };
}
 
#endif /* __PERIPHERAL_SENSORHUB_IDL__ */