Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_boxs.h
Go to the documentation of this file.
1 
9 /**********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_boxs.h
28 *
29 * @purpose Box Services Configuration and Status
30 *
31 * @component OPEN
32 *
33 * @create 11/09/2012
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_BOXS_H_INCLUDED
39 #define OPENAPI_BOXS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_ITEMSTATE_NONE = 0, /* N/A */
47  OPEN_ITEMSTATE_NOT_PRESENT = 1,
48  OPEN_ITEMSTATE_OPERATIONAL = 2,
49  OPEN_ITEMSTATE_FAILED = 3,
50  OPEN_ITEMSTATE_POWERING = 4,
51  OPEN_ITEMSTATE_NOPOWER = 5,
52  OPEN_ITEMSTATE_NOT_POWERING = 6,
53  OPEN_ITEMSTATE_INCOMPATIBLE = 7 /* This state is possible on boards capable of pluggable Power supplies */
54 } OPEN_BOXS_ITEM_STATE_t;
55 
57 typedef enum
58 {
59  OPEN_TEMPSENSOR_STATE_NONE = 0, /* N/A */
60  OPEN_TEMPSENSOR_STATE_NORMAL = 1,
61  OPEN_TEMPSENSOR_STATE_WARNING = 2,
62  OPEN_TEMPSENSOR_STATE_CRITICAL = 3,
63  OPEN_TEMPSENSOR_STATE_SHUTDOWN = 4,
64  OPEN_TEMPSENSOR_STATE_NOTPRESENT = 5,
65  OPEN_TEMPSENSOR_STATE_NOTOPERATIONAL = 6
66 } OPEN_BOXS_TEMPSENSOR_STATE_t;
67 
69 typedef enum
70 {
71  OPEN_TYPE_NONE = 0, /* N/A */
72  OPEN_TYPE_FIXED = 1,
73  OPEN_TYPE_REMOVABLE = 2
74 } OPEN_BOXS_ITEM_TYPE_t;
75 
76 typedef enum
77 {
78  OPEN_MODULE_NONE = 0,
79  OPEN_MODULE_SFP = 1,
80  OPEN_MODULE_SFPPLUS = 2,
81  OPEN_MODULE_QSFP = 3,
82  OPEN_MODULE_DAC = 4,
83  OPEN_MODULE_AX741 = 5,
84  OPEN_MODULE_AX742 = 6,
85  OPEN_MODULE_AX743 = 7,
86  OPEN_MODULE_AX744 = 8,
87  OPEN_MODULE_AX745 = 9
88 }OPEN_SFP_MODULE_TYPE_t;
89 
90 #define OPEN_BXS_STR_BUFFER_SIZE 128
92 /******************************************************************************/
115 open_error_t openapiFiberPortsOpticsFaultStatusGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
116  uint32_t *localFaultStatus, uint32_t *remoteFaultStatus);
117 
118 /******************************************************************************/
145 open_error_t openapiFiberPortsOpticsGet(openapiClientHandle_t *client_handle, uint32_t ifNum,
146  uint32_t *temperature, uint32_t *voltage, uint32_t *current,
147  uint64_t *powerIn, uint64_t *powerOut,
148  OPEN_BOOL_t *txFault, OPEN_BOOL_t *los);
149 
150 /******************************************************************************/
182 open_error_t openapiFiberPortsLaneOpticsGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t lane,
183  uint32_t *temperature, uint32_t *voltage, uint32_t *current,
184  open_buffdesc *powerIn, open_buffdesc *powerOut,
185  OPEN_BOOL_t *txFault, OPEN_BOOL_t *los);
186 
187 /*****************************************************************/
207 open_error_t openapiFiberPortsTransceiverPresenceGet(openapiClientHandle_t *client_handle,
208  uint32_t ifNum, OPEN_BOOL_t *present);
209 
210 /*****************************************************************/
224 open_error_t openapiBoxsiGeneralFanSpeedGet (openapiClientHandle_t * client_handle,
225  uint32_t * genFanSpeed);
226 
227 /*****************************************************************/
241 open_error_t openapiBoxsiGeneralFanDutyLevelGet (openapiClientHandle_t * client_handle,
242  uint32_t * genFanDutyLevel);
243 
244 /******************************************************************************/
258 open_error_t openapiBoxsNumOfFansGet (openapiClientHandle_t * client_handle,
259  uint32_t * numFans);
260 
261 /*****************************************************************/
276 open_error_t openapiBoxsFanSpeedGet (openapiClientHandle_t * client_handle,
277  uint32_t fanNum, uint32_t * fanSpeed);
278 
279 
280 /*****************************************************************/
295 open_error_t openapiBoxsFanStateGet (openapiClientHandle_t * client_handle,
296  uint32_t fanNum,
297  OPEN_BOXS_ITEM_STATE_t * fanState);
298 
299 /*****************************************************************/
314 open_error_t openapiBoxsFanTypeGet (openapiClientHandle_t * client_handle,
315  uint32_t fanNum,
316  OPEN_BOXS_ITEM_TYPE_t * fanType);
317 
318 /*****************************************************************/
333 open_error_t openapiBoxsFanDutyCycleGet (openapiClientHandle_t * client_handle,
334  uint32_t fanNum, uint32_t * fanDuty);
335 
336 /*****************************************************************************************/
349 open_error_t openapiBoxsFanDescripSizeGet (openapiClientHandle_t *
350  client_handle,
351  uint32_t * descripSize);
352 
353 /*****************************************************************************************/
370 open_error_t openapiBoxsFanDescripGet (openapiClientHandle_t *
371  client_handle,
372  uint32_t fanNum,
373  open_buffdesc * descrip);
374 
375 /*****************************************************************/
389 open_error_t openapiBoxsNumOfPowSuppliesGet (openapiClientHandle_t *
390  client_handle,
391  uint32_t * numPowSuplies);
392 
393 /*****************************************************************/
408 open_error_t openapiBoxsPowSupplyStateGet (openapiClientHandle_t *
409  client_handle, uint32_t psNo,
410  OPEN_BOXS_ITEM_STATE_t * psState);
411 
412 /*****************************************************************/
427 open_error_t openapiBoxsPowSupplyTypeGet (openapiClientHandle_t *
428  client_handle, uint32_t psNo,
429  OPEN_BOXS_ITEM_TYPE_t * psType);
430 
431 /*****************************************************************************************/
444 open_error_t openapiBoxsPowSupplyDescripSizeGet (openapiClientHandle_t *
445  client_handle,
446  uint32_t * descripSize);
447 
448 /*****************************************************************************************/
465 open_error_t openapiBoxsPowSupplyDescripGet (openapiClientHandle_t *
466  client_handle,
467  uint32_t psNum,
468  open_buffdesc * descrip);
469 
470 /*****************************************************************/
485 open_error_t openapiBoxsTempRangeGet (openapiClientHandle_t *
486  client_handle,
487  uint32_t * minTemp,
488  uint32_t * maxTemp);
489 
490 /************************************************************************************/
504 open_error_t openapiBoxsGeneralTempGet (openapiClientHandle_t *
505  client_handle,
506  uint32_t * genTemp);
507 
508 /*****************************************************************/
522 open_error_t openapiBoxsNumOfTempSensorsGet (openapiClientHandle_t *
523  client_handle,
524  uint32_t * numOfTempSemsors);
525 
526 /*****************************************************************************************/
540 open_error_t openapiBoxsTempSensorDescripSizeGet (openapiClientHandle_t *
541  client_handle,
542  uint32_t * descripSize);
543 
544 /*****************************************************************************************/
561 open_error_t openapiBoxsTempSensorDescripGet (openapiClientHandle_t *
562  client_handle,
563  uint32_t sensorNum,
564  open_buffdesc * descrip);
565 
566 /************************************************************************************/
579 open_error_t openapiBoxsTempGet (openapiClientHandle_t * client_handle,
580  uint32_t sensorNum, uint32_t * temperature);
581 
582 /*****************************************************************/
596 open_error_t openapiBoxsTempSensorStatusGet (openapiClientHandle_t *
597  client_handle, uint32_t sensorNum,
598  OPEN_BOXS_TEMPSENSOR_STATE_t *
599  state);
600 
601 /*******************************************************************************/
616 open_error_t openapiBoxsTempSensorMaxTempGet (openapiClientHandle_t *
617  client_handle,
618  uint32_t sensorNum,
619  uint32_t * maxTemperature);
620 
621 /*****************************************************************/
635 open_error_t openapiBoxsSfpTypeGet(openapiClientHandle_t *client_handle,
636  uint32_t ifNum, OPEN_SFP_MODULE_TYPE_t *moduleType);
637 
638 /*****************************************************************/
656 open_error_t openapiBoxsSfpVendorNameGet(openapiClientHandle_t *client_handle,
657  uint32_t ifNum, open_buffdesc *vendorNameDesc);
658 
659 /*****************************************************************/
677 open_error_t openapiBoxsSfpSerialNumberGet(openapiClientHandle_t *client_handle,
678  uint32_t ifNum, open_buffdesc *serialNumberDesc);
679 
680 /*****************************************************************/
698 open_error_t openapiBoxsSfpPartNumberGet(openapiClientHandle_t *client_handle,
699  uint32_t ifNum, open_buffdesc *partNumberDesc);
700 
701 
702 /*****************************************************************/
719 open_error_t openapiBoxsSfpVendorRevisionGet(openapiClientHandle_t *client_handle,
720  uint32_t ifNum, open_buffdesc *vendorRevDesc);
721 
722 /*****************************************************************/
737 open_error_t openapiBoxsSfpLinkLength50umGet(openapiClientHandle_t *client_handle,
738  uint32_t ifNum, uint32_t *linkLength50um);
739 
740 /*****************************************************************/
755 open_error_t openapiBoxsSfpLinkLength62_5umGet(openapiClientHandle_t *client_handle,
756  uint32_t ifNum, uint32_t *linkLength62_5um);
757 
758 /*****************************************************************/
774 open_error_t openapiBoxsSfpNominalSignalRate(openapiClientHandle_t *client_handle,
775  uint32_t ifNum, uint32_t *nominalSigRate);
776 
777 /*****************************************************************/
795 open_error_t openapiBoxsSfpComplianceGet(openapiClientHandle_t *client_handle,
796  uint32_t ifNum, open_buffdesc *complianceDesc);
797 
798 /*****************************************************************/
810 open_error_t openapiBoxsSfpVendorNameSizeGet(openapiClientHandle_t *client_handle,
811  uint32_t *vendorNameSize);
812 
813 /*****************************************************************/
825 open_error_t openapiBoxsSfpSerialNumberSizeGet(openapiClientHandle_t *client_handle,
826  uint32_t *serialNumberSize);
827 
828 /*****************************************************************/
840 open_error_t openapiBoxsSfpPartNumberSizeGet(openapiClientHandle_t *client_handle,
841  uint32_t *partNumberSize);
842 
843 /*****************************************************************/
855 open_error_t openapiBoxsSfpVendorRevSizeGet(openapiClientHandle_t *client_handle,
856  uint32_t *vendorRevSize);
857 
858 /*****************************************************************/
870 open_error_t openapiBoxsSfpComplianceSizeGet(openapiClientHandle_t *client_handle,
871  uint32_t *complianceSize);
872 
873 /*****************************************************************/
885 open_error_t openapiPortLocatorGlobalDisable(openapiClientHandle_t *client_handle);
886 
887 /*****************************************************************/
901 open_error_t openapiPortLocatorInterfaceEnable(openapiClientHandle_t *client_handle,
902  uint32_t interface,
903  OPEN_CONTROL_t enable);
904 
905 /*****************************************************************/
922 open_error_t openapiCpldVersionGet(openapiClientHandle_t *client_handle,
923  open_buffdesc *cpldVersion);
924 #endif /* OPENAPI_BOXS_H_INCLUDED */
925