Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_stacking.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_stacking.h
28 *
29 * @purpose Stacking Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 10/22/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_STACKING_H_INCLUDED
39 #define OPENAPI_STACKING_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
44 typedef enum
45 {
46  OPEN_USMDB_UNITMGR_UNIT_OK = 1,
47  OPEN_USMDB_UNITMGR_UNIT_UNSUPPORTED = 2,
48  OPEN_USMDB_UNITMGR_CODE_MISMATCH = 3,
49  OPEN_USMDB_UNITMGR_CFG_MISMATCH = 4,
50  OPEN_USMDB_UNITMGR_SDM_MISMATCH = 5,
51  OPEN_USMDB_UNITMGR_UNIT_NOT_PRESENT = 6,
52  OPEN_USMDB_UNITMGR_CODE_UPDATE = 7,
53  OPEN_USMDB_UNITMGR_STM_MISMATCH = 8
54 } OPEN_USMDB_UNITMGR_STATUS_t;
55 
57 typedef enum
58 {
59  OPEN_USMDB_UNITMGR_MGMT_ENABLED = 1,
60  OPEN_USMDB_UNITMGR_MGMT_DISABLED = 2,
61  OPEN_USMDB_UNITMGR_MGMT_UNASSIGNED = 3
62 } OPEN_USMDB_UNITMGR_MGMT_FLAG_t;
63 
65 typedef enum
66 {
67  OPEN_USMDB_UNITMGR_MGMTPREF_DISABLED = 0,
68  OPEN_USMDB_UNITMGR_MGMTPREF_1 = 1,
69  OPEN_USMDB_UNITMGR_MGMTPREF_2 = 2,
70  OPEN_USMDB_UNITMGR_MGMTPREF_3 = 3,
71  OPEN_USMDB_UNITMGR_MGMTPREF_4 = 4,
72  OPEN_USMDB_UNITMGR_MGMTPREF_5 = 5,
73  OPEN_USMDB_UNITMGR_MGMTPREF_6 = 6,
74  OPEN_USMDB_UNITMGR_MGMTPREF_7 = 7,
75  OPEN_USMDB_UNITMGR_MGMTPREF_8 = 8,
76  OPEN_USMDB_UNITMGR_MGMTPREF_9 = 9,
77  OPEN_USMDB_UNITMGR_MGMTPREF_10 = 10,
78  OPEN_USMDB_UNITMGR_MGMTPREF_11 = 11,
79  OPEN_USMDB_UNITMGR_MGMTPREF_12 = 12,
80  OPEN_USMDB_UNITMGR_MGMTPREF_13 = 13,
81  OPEN_USMDB_UNITMGR_MGMTPREF_14 = 14,
82  OPEN_USMDB_UNITMGR_MGMTPREF_15 = 15,
83  OPEN_USMDB_UNITMGR_MGMTFUNC_UNASSIGNED = 16
84 } OPEN_USMDB_UNITMGR_MGMTPREF_t;
85 
87 typedef enum
88 {
89  OPEN_SFS_SWITCH_STATUS_NO_ACTION = 1,
90  OPEN_SFS_SWITCH_STATUS_IN_PROGRESS = 2
91 } OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t;
92 
94 typedef enum
95 {
96  OPEN_SFS_NONE = 1,
97  OPEN_SFS_SUCCESS = 2,
98  OPEN_SFS_FAIL = 3,
99  OPEN_SFS_MIN_BOOTCODE_VERSION_NOT_PRESENT = 4
100 } OPEN_SFS_LAST_ATTEMPT_STATUS_t;
101 
102 
103 /*****************************************************************/
118 open_error_t openapiUnitMgrStackMemberGetNext(openapiClientHandle_t *client_handle,
119  uint32_t startUnit,
120  uint32_t *nextUnit);
121 
122 /*****************************************************************/
136 open_error_t openapiUnitMgrNumberGet(openapiClientHandle_t *client_handle,
137  uint32_t *unit);
138 
139 /*****************************************************************/
156 open_error_t openapiUnitMgrSerialNumberGet(openapiClientHandle_t *client_handle,
157  uint32_t unit,
158  open_buffdesc *serialNumber);
159 
160 /*****************************************************************/
177 open_error_t openapiUnitMgrServiceTagGet(openapiClientHandle_t *client_handle,
178  uint32_t unit,
179  open_buffdesc *serviceTag);
180 
181 /*****************************************************************/
199 open_error_t openapiUnitMgrPreconfigModelIdGet(openapiClientHandle_t *client_handle,
200  uint32_t unit,
201  open_buffdesc *modelId);
202 
203 /*****************************************************************/
219 open_error_t openapiUnitMgrUnitIsValid(openapiClientHandle_t *client_handle,
220  uint32_t unit,
221  OPEN_BOOL_t *isValid);
222 
223 /*****************************************************************/
238 open_error_t openapiUnitMgrUnitMaxGet(openapiClientHandle_t *client_handle,
239  uint32_t *unit);
240 
241 /*****************************************************************/
256 open_error_t openapiUnitMgrUnitStatusGet(openapiClientHandle_t *client_handle,
257  uint32_t unit,
258  OPEN_USMDB_UNITMGR_STATUS_t *status);
259 
260 /*****************************************************************/
275 open_error_t openapiUnitMgrMgmtUnitStatusGet(openapiClientHandle_t *client_handle,
276  uint32_t unit,
277  OPEN_USMDB_UNITMGR_MGMT_FLAG_t *mgmtStatus);
278 
279 /*****************************************************************/
300 open_error_t openapiUnitMgrModelIdentifierGet(openapiClientHandle_t *client_handle,
301  uint32_t unit,
302  open_buffdesc *modelId,
303  open_buffdesc *preconfigModelId);
304 
305 /*****************************************************************/
320 open_error_t openapiUnitMgrDetectCodeVerFlashGet(openapiClientHandle_t *client_handle,
321  uint32_t unit,
322  open_revision_data_t *codeVersion);
323 
324 /*****************************************************************/
339 open_error_t openapiUnitMgrDetectCodeVerRunningGet(openapiClientHandle_t *client_handle,
340  uint32_t unit,
341  open_revision_data_t *codeVersion);
342 
343 /*****************************************************************/
359 open_error_t openapiUnitMgrMgmtPrefGet(openapiClientHandle_t *client_handle,
360  uint32_t unit,
361  OPEN_USMDB_UNITMGR_MGMTPREF_t *hwPref,
362  OPEN_USMDB_UNITMGR_MGMTPREF_t *adminPref);
363 
364 /*****************************************************************/
381 open_error_t openapiUnitMgrUnitTypeGet(openapiClientHandle_t *client_handle,
382  uint32_t unit,
383  uint32_t *unitType,
384  uint32_t *unitTypeIndex);
385 
386 /*****************************************************************/
403 open_error_t openapiUnitMgrSupportedDescriptionGet(openapiClientHandle_t *client_handle,
404  uint32_t unitTypeIndex,
405  open_buffdesc *unitDescr);
406 
407 /*****************************************************************/
422 open_error_t openapiUnitMgrStackFirmwareSyncMemberStatusGet(openapiClientHandle_t *client_handle,
423  uint32_t unit,
424  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus);
425 
426 /*****************************************************************/
441 open_error_t openapiUnitMgrStackFirmwareSyncStatusGet(openapiClientHandle_t *client_handle,
442  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus);
443 
444 /*****************************************************************/
460 open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet(openapiClientHandle_t *client_handle,
461  uint32_t unit,
462  uint32_t *lastAttemptStatus);
463 
464 /*****************************************************************/
480 open_error_t openapiStmUnitActiveTemplateIdGet(openapiClientHandle_t *client_handle,
481  uint32_t unit,
482  uint32_t *templateId);
483 
484 /*****************************************************************/
500 open_error_t openapiStmTemplateDescriptionGet(openapiClientHandle_t *client_handle,
501  uint32_t templateId,
502  open_buffdesc *templateDescr);
503 
504 /*****************************************************************/
519 open_error_t openapiUnitMgrUnitUpTimeGet(openapiClientHandle_t *client_handle,
520  uint32_t unit,
521  uint32_t *upTime);
522 
523 /*****************************************************************/
540 open_error_t openapiUnitMgrSupportedUnitIdGet(openapiClientHandle_t *client_handle,
541  uint32_t unitTypeIndex,
542  uint32_t *unitType);
543 
544 /*****************************************************************/
562 open_error_t openapiUnitMgrSupportedUnitIdNextGet(openapiClientHandle_t *client_handle,
563  uint32_t unitTypeIndex,
564  uint32_t *nextUnitTypeIndex,
565  uint32_t *unitType);
566 
567 /*****************************************************************/
587 open_error_t openapiUnitMgrUnitCreate(openapiClientHandle_t *client_handle,
588  uint32_t unit,
589  uint32_t unitTypeIndex,
590  OPEN_BOOL_t synchMode);
591 
592 /*****************************************************************/
608 open_error_t openapiUnitMgrUnitDelete(openapiClientHandle_t *client_handle,
609  uint32_t unit);
610 
611 /*****************************************************************/
626 open_error_t openapiUnitMgrUnitTransfer(openapiClientHandle_t *client_handle,
627  uint32_t targetUnit);
628 
629 /*****************************************************************/
646 open_error_t openapiSpmFpsConfigQosModeGet(openapiClientHandle_t *client_handle,
647  OPEN_CONTROL_t *fpsQosMode);
648 
649 /*****************************************************************/
665 open_error_t openapiSpmFpsConfigQosModeSet(openapiClientHandle_t *client_handle,
666  OPEN_CONTROL_t fpsQosMode);
667 
668 /*****************************************************************/
685 open_error_t openapiUnitMgrStandbyGet(openapiClientHandle_t *client_handle,
686  uint32_t *configUnit,
687  uint32_t *standbyUnit,
688  OPEN_BOOL_t *standbyAdminMode);
689 
690 /*****************************************************************/
705 open_error_t openapiUnitMgrStandbySet(openapiClientHandle_t *client_handle,
706  uint32_t standbyUnit,
707  OPEN_BOOL_t standbyAdminMode);
708 
709 /*****************************************************************/
729 open_error_t openapiSpmFpsConfigStackingModeGet(openapiClientHandle_t *client_handle,
730  uint32_t unit,
731  uint32_t slot,
732  uint32_t port,
733  OPEN_BOOL_t *stackPortMode);
734 
735 /*****************************************************************/
754 open_error_t openapiSpmFpsConfigStackingModeSet(openapiClientHandle_t *client_handle,
755  uint32_t unit,
756  uint32_t slot,
757  uint32_t port,
758  OPEN_BOOL_t stackPortMode);
759 
760 
761 
762 /*****************************************************************/
779 open_error_t openapiSlotGet(openapiClientHandle_t *client_handle,
780  uint32_t unit,
781  uint32_t slot,
782  OPEN_BOOL_t *isValid);
783 
784 /**********************************************************************/
802 open_error_t openapiUnitDbEntrySlotsGet(openapiClientHandle_t *client_handle,
803  uint32_t unit,
804  uint32_t *count,
805  open_buffdesc *bufd);
806 
807 /*****************************************************************/
826 open_error_t openapiSlotIsFullGet(openapiClientHandle_t *client_handle,
827  uint32_t unit,
828  uint32_t slot,
829  OPEN_BOOL_t *isFull);
830 
831 /*****************************************************************/
851 open_error_t openapiSlotAdminModeGet(openapiClientHandle_t *client_handle,
852  uint32_t unit,
853  uint32_t slot,
854  OPEN_CONTROL_t *adminMode);
855 
856 /*****************************************************************/
876 open_error_t openapiSlotAdminModeSet(openapiClientHandle_t *client_handle,
877  uint32_t unit,
878  uint32_t slot,
879  OPEN_CONTROL_t adminMode);
880 
881 /*****************************************************************/
901 open_error_t openapiSlotPowerModeGet(openapiClientHandle_t *client_handle,
902  uint32_t unit,
903  uint32_t slot,
904  OPEN_CONTROL_t *powerMode);
905 
906 /*****************************************************************/
926 open_error_t openapiSlotPowerModeSet(openapiClientHandle_t *client_handle,
927  uint32_t unit,
928  uint32_t slot,
929  OPEN_CONTROL_t powerMode);
930 
931 /*****************************************************************/
950 open_error_t openapiCardTypeGet(openapiClientHandle_t *client_handle,
951  uint32_t unit,
952  uint32_t slot,
953  uint32_t *cardIdConfig,
954  uint32_t *cardIdInsert);
955 
956 /*****************************************************************/
973 open_error_t openapiCardSupportedCardModelIdGet(openapiClientHandle_t *client_handle,
974  uint32_t cardId,
975  open_buffdesc *bufd);
976 
977 /*****************************************************************/
994 open_error_t openapiCardSupportedCardDescriptionGet(openapiClientHandle_t *client_handle,
995  uint32_t cardId,
996  open_buffdesc *bufd);
997 
998 /*****************************************************************/
1017 open_error_t openapiSlotSupportedPluggableGet(openapiClientHandle_t *client_handle,
1018  uint32_t unit,
1019  uint32_t slot,
1020  OPEN_BOOL_t *isPluggable);
1021 
1022 /*****************************************************************/
1041 open_error_t openapiSlotSupportedPowerdownGet(openapiClientHandle_t *client_handle,
1042  uint32_t unit,
1043  uint32_t slot,
1044  OPEN_BOOL_t *isPowerdown);
1045 
1046 #endif /* OPENAPI_STACKING_H_INCLUDED */
1047