Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
openapi_stacking.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2020 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 #define OPEN_UNITMGR_ROOTFS_VER_SIZE 33
103 #define OPEN_UNITMGR_ROOTFS_VER_LENGTH 32
104 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE "/mnt/fastpath/upper1.tgz"
105 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_VER_FILE "/mnt/fastpath/upper1.md5"
106 #define OPEN_CDA_FILE_NAME_LENGTH 128
107 #define OPEN_UNITMGR_ROOTFS_COMPAT_FILE "/etc/bootstrap-distro-compat"
108 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_FILE_NAME_LENGTH 64
109 #define OPEN_UNITMGR_ROOTFS_SNAPSHOT_VERSION_FILE_NAME_LENGTH 64
110 #define OPEN_UNITMGR_LEGACY_ROOTFS_COMPAT_STRING "1"
111 #define OPEN_UNITMGR_ROOTFS_COMPAT_STRING_LENGTH 32
112 
113 
114 /*****************************************************************/
129 open_error_t openapiUnitMgrStackMemberGetNext(openapiClientHandle_t *client_handle,
130  uint32_t startUnit,
131  uint32_t *nextUnit);
132 
133 /*****************************************************************/
147 open_error_t openapiUnitMgrNumberGet(openapiClientHandle_t *client_handle,
148  uint32_t *unit);
149 
150 /*****************************************************************/
167 open_error_t openapiUnitMgrSerialNumberGet(openapiClientHandle_t *client_handle,
168  uint32_t unit,
169  open_buffdesc *serialNumber);
170 
171 /*****************************************************************/
188 open_error_t openapiUnitMgrServiceTagGet(openapiClientHandle_t *client_handle,
189  uint32_t unit,
190  open_buffdesc *serviceTag);
191 
192 /*****************************************************************/
210 open_error_t openapiUnitMgrPreconfigModelIdGet(openapiClientHandle_t *client_handle,
211  uint32_t unit,
212  open_buffdesc *modelId);
213 
214 /*****************************************************************/
230 open_error_t openapiUnitMgrUnitIsValid(openapiClientHandle_t *client_handle,
231  uint32_t unit,
232  OPEN_BOOL_t *isValid);
233 
234 /*****************************************************************/
249 open_error_t openapiUnitMgrUnitMaxGet(openapiClientHandle_t *client_handle,
250  uint32_t *unit);
251 
252 /*****************************************************************/
267 open_error_t openapiUnitMgrUnitStatusGet(openapiClientHandle_t *client_handle,
268  uint32_t unit,
269  OPEN_USMDB_UNITMGR_STATUS_t *status);
270 
271 /*****************************************************************/
286 open_error_t openapiUnitMgrMgmtUnitStatusGet(openapiClientHandle_t *client_handle,
287  uint32_t unit,
288  OPEN_USMDB_UNITMGR_MGMT_FLAG_t *mgmtStatus);
289 
290 /*****************************************************************/
311 open_error_t openapiUnitMgrModelIdentifierGet(openapiClientHandle_t *client_handle,
312  uint32_t unit,
313  open_buffdesc *modelId,
314  open_buffdesc *preconfigModelId);
315 
316 /*****************************************************************/
331 open_error_t openapiUnitMgrDetectCodeVerFlashGet(openapiClientHandle_t *client_handle,
332  uint32_t unit,
333  open_revision_data_t *codeVersion);
334 
335 /*****************************************************************/
350 open_error_t openapiUnitMgrDetectCodeVerRunningGet(openapiClientHandle_t *client_handle,
351  uint32_t unit,
352  open_revision_data_t *codeVersion);
353 
354 /*****************************************************************/
370 open_error_t openapiUnitMgrMgmtPrefGet(openapiClientHandle_t *client_handle,
371  uint32_t unit,
372  OPEN_USMDB_UNITMGR_MGMTPREF_t *hwPref,
373  OPEN_USMDB_UNITMGR_MGMTPREF_t *adminPref);
374 
375 /*****************************************************************/
392 open_error_t openapiUnitMgrUnitTypeGet(openapiClientHandle_t *client_handle,
393  uint32_t unit,
394  uint32_t *unitType,
395  uint32_t *unitTypeIndex);
396 
397 /*****************************************************************/
414 open_error_t openapiUnitMgrSupportedDescriptionGet(openapiClientHandle_t *client_handle,
415  uint32_t unitTypeIndex,
416  open_buffdesc *unitDescr);
417 
418 /*****************************************************************/
433 open_error_t openapiUnitMgrStackFirmwareSyncMemberStatusGet(openapiClientHandle_t *client_handle,
434  uint32_t unit,
435  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus);
436 
437 /*****************************************************************/
452 open_error_t openapiUnitMgrStackFirmwareSyncStatusGet(openapiClientHandle_t *client_handle,
453  OPEN_UNIT_MGR_SFS_SWITCH_STATUS_t *firmwareSyncStatus);
454 
455 /*****************************************************************/
471 open_error_t openapiUnitMgrStackFirmwareSyncMemberLastAttemptStatusGet(openapiClientHandle_t *client_handle,
472  uint32_t unit,
473  uint32_t *lastAttemptStatus);
474 
475 /*****************************************************************/
491 open_error_t openapiStmUnitActiveTemplateIdGet(openapiClientHandle_t *client_handle,
492  uint32_t unit,
493  uint32_t *templateId);
494 
495 /*****************************************************************/
511 open_error_t openapiStmTemplateDescriptionGet(openapiClientHandle_t *client_handle,
512  uint32_t templateId,
513  open_buffdesc *templateDescr);
514 
515 /*****************************************************************/
530 open_error_t openapiUnitMgrUnitUpTimeGet(openapiClientHandle_t *client_handle,
531  uint32_t unit,
532  uint32_t *upTime);
533 
534 /*****************************************************************/
551 open_error_t openapiUnitMgrSupportedUnitIdGet(openapiClientHandle_t *client_handle,
552  uint32_t unitTypeIndex,
553  uint32_t *unitType);
554 
555 /*****************************************************************/
573 open_error_t openapiUnitMgrSupportedUnitIdNextGet(openapiClientHandle_t *client_handle,
574  uint32_t unitTypeIndex,
575  uint32_t *nextUnitTypeIndex,
576  uint32_t *unitType);
577 
578 /*****************************************************************/
598 open_error_t openapiUnitMgrUnitCreate(openapiClientHandle_t *client_handle,
599  uint32_t unit,
600  uint32_t unitTypeIndex,
601  OPEN_BOOL_t synchMode);
602 
603 /*****************************************************************/
619 open_error_t openapiUnitMgrUnitDelete(openapiClientHandle_t *client_handle,
620  uint32_t unit);
621 
622 /*****************************************************************/
637 open_error_t openapiUnitMgrUnitTransfer(openapiClientHandle_t *client_handle,
638  uint32_t targetUnit);
639 
640 /*****************************************************************/
657 open_error_t openapiSpmFpsConfigQosModeGet(openapiClientHandle_t *client_handle,
658  OPEN_CONTROL_t *fpsQosMode);
659 
660 /*****************************************************************/
676 open_error_t openapiSpmFpsConfigQosModeSet(openapiClientHandle_t *client_handle,
677  OPEN_CONTROL_t fpsQosMode);
678 
679 /*****************************************************************/
696 open_error_t openapiUnitMgrStandbyGet(openapiClientHandle_t *client_handle,
697  uint32_t *configUnit,
698  uint32_t *standbyUnit,
699  OPEN_BOOL_t *standbyAdminMode);
700 
701 /*****************************************************************/
716 open_error_t openapiUnitMgrStandbySet(openapiClientHandle_t *client_handle,
717  uint32_t standbyUnit,
718  OPEN_BOOL_t standbyAdminMode);
719 
720 /*****************************************************************/
740 open_error_t openapiSpmFpsConfigStackingModeGet(openapiClientHandle_t *client_handle,
741  uint32_t unit,
742  uint32_t slot,
743  uint32_t port,
744  OPEN_BOOL_t *stackPortMode);
745 
746 /*****************************************************************/
765 open_error_t openapiSpmFpsConfigStackingModeSet(openapiClientHandle_t *client_handle,
766  uint32_t unit,
767  uint32_t slot,
768  uint32_t port,
769  OPEN_BOOL_t stackPortMode);
770 
771 
772 
773 /*****************************************************************/
790 open_error_t openapiSlotGet(openapiClientHandle_t *client_handle,
791  uint32_t unit,
792  uint32_t slot,
793  OPEN_BOOL_t *isValid);
794 
795 /**********************************************************************/
813 open_error_t openapiUnitDbEntrySlotsGet(openapiClientHandle_t *client_handle,
814  uint32_t unit,
815  uint32_t *count,
816  open_buffdesc *bufd);
817 
818 /*****************************************************************/
837 open_error_t openapiSlotIsFullGet(openapiClientHandle_t *client_handle,
838  uint32_t unit,
839  uint32_t slot,
840  OPEN_BOOL_t *isFull);
841 
842 /*****************************************************************/
862 open_error_t openapiSlotAdminModeGet(openapiClientHandle_t *client_handle,
863  uint32_t unit,
864  uint32_t slot,
865  OPEN_CONTROL_t *adminMode);
866 
867 /*****************************************************************/
887 open_error_t openapiSlotAdminModeSet(openapiClientHandle_t *client_handle,
888  uint32_t unit,
889  uint32_t slot,
890  OPEN_CONTROL_t adminMode);
891 
892 /*****************************************************************/
912 open_error_t openapiSlotPowerModeGet(openapiClientHandle_t *client_handle,
913  uint32_t unit,
914  uint32_t slot,
915  OPEN_CONTROL_t *powerMode);
916 
917 /*****************************************************************/
937 open_error_t openapiSlotPowerModeSet(openapiClientHandle_t *client_handle,
938  uint32_t unit,
939  uint32_t slot,
940  OPEN_CONTROL_t powerMode);
941 
942 /*****************************************************************/
961 open_error_t openapiCardTypeGet(openapiClientHandle_t *client_handle,
962  uint32_t unit,
963  uint32_t slot,
964  uint32_t *cardIdConfig,
965  uint32_t *cardIdInsert);
966 
967 /*****************************************************************/
984 open_error_t openapiCardSupportedCardModelIdGet(openapiClientHandle_t *client_handle,
985  uint32_t cardId,
986  open_buffdesc *bufd);
987 
988 /*****************************************************************/
1005 open_error_t openapiCardSupportedCardDescriptionGet(openapiClientHandle_t *client_handle,
1006  uint32_t cardId,
1007  open_buffdesc *bufd);
1008 
1009 /*****************************************************************/
1028 open_error_t openapiSlotSupportedPluggableGet(openapiClientHandle_t *client_handle,
1029  uint32_t unit,
1030  uint32_t slot,
1031  OPEN_BOOL_t *isPluggable);
1032 
1033 /*****************************************************************/
1052 open_error_t openapiSlotSupportedPowerdownGet(openapiClientHandle_t *client_handle,
1053  uint32_t unit,
1054  uint32_t slot,
1055  OPEN_BOOL_t *isPowerdown);
1056 
1057 /*****************************************************************/
1081 open_error_t openapiCdaTransferFile(openapiClientHandle_t *client_handle,
1082  uint32_t unit,
1083  open_buffdesc *srcFileName,
1084  open_buffdesc *dstFileName);
1085 
1086 /*****************************************************************/
1105 open_error_t openapiUnitMgrDebianRootfsVerGet(openapiClientHandle_t *client_handle,
1106  uint32_t unit,
1107  open_buffdesc *version);
1108 
1109 /*****************************************************************/
1128 open_error_t openapiUnitMgrDebianRootfsVerSet(openapiClientHandle_t *client_handle,
1129  uint32_t unit,
1130  open_buffdesc *version);
1131 
1132 /*****************************************************************/
1151 open_error_t openapiUnitMgrDebianRootfsOperVerGet(openapiClientHandle_t *client_handle,
1152  uint32_t unit,
1153  open_buffdesc *version);
1154 
1155 /*****************************************************************/
1174 open_error_t openapiUnitMgrDebianRootfsOperVerSet(openapiClientHandle_t *client_handle,
1175  uint32_t unit,
1176  open_buffdesc *version);
1177 
1178 /*****************************************************************/
1193 open_error_t openapiUnitMgrResetUnit(openapiClientHandle_t *client_handle,
1194  uint32_t unit);
1195 
1196 /*****************************************************************/
1213 open_error_t openapiUnitMgrDebianRootfsFileNameGet(openapiClientHandle_t *client_handle,
1214  uint32_t unit,
1215  open_buffdesc *filename);
1216 
1217 /*****************************************************************/
1234 open_error_t openapiUnitMgrDebianRootfsVersionFileNameGet(openapiClientHandle_t *client_handle,
1235  uint32_t unit,
1236  open_buffdesc *version);
1237 
1238 #endif /* OPENAPI_STACKING_H_INCLUDED */
1239