Raritan PX2/PX3 JSON-RPC API
PeripheralG2Production.idl
1 #ifndef __PERIPHERAL_G2_PRODUCTION_IDL__
2 #define __PERIPHERAL_G2_PRODUCTION_IDL__
3 
4 #include <PeripheralDeviceSlot.idl>
5 
6 module peripheral {
7  interface G2Production_3_0_0 {
8  constant int ERR_INVALID_PARAMS = 1;
9  constant int ERR_NO_CONFIG_MODE = 2;
10  constant int ERR_NO_DEVICE = 3;
11  constant int ERR_NO_FIRMWARE_FILE = 4;
12  constant int ERR_FIRMWARE_INVALID = 5;
13  constant int ERR_PROTECTED = 6;
14  constant int ERR_UPDATE_IN_PROGRESS = 7;
15 
16  /*** firmware update **************************************************/
17 
18  structure FirmwareInfo {
19  int crc;
20  string compiler;
21  int compilerVersion;
22  string compileDate;
23  int version;
24  int subVersion;
25  int configurationId;
26  string updateDate;
27  };
28 
47  int updateFirmware(in string romcode, in string firmware);
48  int updateFirmwarePos(in vector<PosElement> position, in string firmware);
49 
62  int getFirmwareInfo(in string romcode, out FirmwareInfo info);
63  int getFirmwareInfoPos(in vector<PosElement> position,
64  out FirmwareInfo info);
65 
66  /*** configuration ****************************************************/
67 
68  enumeration ConfigurationSpace {
72  RESERVED
73  };
74 
87  int readConfigurationSpace(in string romcode,
88  in ConfigurationSpace cs,
89  out vector<byte> cfg);
90  int readConfigurationSpacePos(in vector<PosElement> position,
91  in ConfigurationSpace cs,
92  out vector<byte> cfg);
93 
106  int eraseConfigurationSpace(in string romcode,
107  in ConfigurationSpace cs);
108  int eraseConfigurationSpacePos(in vector<PosElement> position,
109  in ConfigurationSpace cs);
110 
125  int writeConfigurationSpace(in string romcode,
126  in ConfigurationSpace cs,
127  in vector<byte> cfg);
128  int writeConfigurationSpacePos(in vector<PosElement> position,
129  in ConfigurationSpace cs,
130  in vector<byte> cfg);
131 
132  /*** register access **************************************************/
133 
149  int readRegisters(in string romcode,
150  in int address, in int count,
151  out vector<byte> data);
152  int readRegistersPos(in vector<PosElement> position,
153  in int address, in int count,
154  out vector<byte> data);
155 
171  int writeRegisters(in string romcode,
172  in int address, in vector<byte> data);
173  int writeRegistersPos(in vector<PosElement> position,
174  in int address, in vector<byte> data);
175 
192  int writeRegisterBits(in string romcode,
193  in int address, in byte mask, in byte bits);
194  int writeRegisterBitsPos(in vector<PosElement> position,
195  in int address, in byte mask, in byte bits);
196 
197  /*** utils ************************************************************/
198 
199  enumeration ResetMethod {
201  WATCHDOG
202  };
203 
214  int reset(in string romcode, in ResetMethod method);
215  int resetPos(in vector<PosElement> position, in ResetMethod method);
216  };
217 }
218 
219 #endif /* !__PERIPHERAL_G2_PRODUCTION_IDL__ */
Peripheral Devices.
Definition: PeripheralDeviceManager.idl:11
Definition: PeripheralG2Production.idl:18
HW-specific configuration data.
Definition: PeripheralG2Production.idl:69
vector< PosElement > position
Position within 1-wire topo.
Definition: PeripheralDeviceSlot.idl:49
Firmware Management
Definition: Firmware.idl:4
ResetMethod
Definition: PeripheralG2Production.idl:199
Firmware-specific configuration data.
Definition: PeripheralG2Production.idl:71
ConfigurationSpace
Definition: PeripheralG2Production.idl:68
Definition: PeripheralG2Production.idl:7
Function-specific configuration data.
Definition: PeripheralG2Production.idl:70
reset triggered instantly by firmware
Definition: PeripheralG2Production.idl:200