Shad Ansari | 2f7f9be | 2017-06-07 13:34:53 -0700 | [diff] [blame] | 1 | /* |
| 2 | <:copyright-BRCM:2016:DUAL/GPL:standard |
| 3 | |
| 4 | Broadcom Proprietary and Confidential.(c) 2016 Broadcom |
| 5 | All Rights Reserved |
| 6 | |
| 7 | Unless you and Broadcom execute a separate written software license |
| 8 | agreement governing use of this software, this software is licensed |
| 9 | to you under the terms of the GNU General Public License version 2 |
| 10 | (the "GPL"), available at http://www.broadcom.com/licenses/GPLv2.php, |
| 11 | with the following added to such license: |
| 12 | |
| 13 | As a special exception, the copyright holders of this software give |
| 14 | you permission to link this software with independent modules, and |
| 15 | to copy and distribute the resulting executable under terms of your |
| 16 | choice, provided that you also meet, for each linked independent |
| 17 | module, the terms and conditions of the license of that module. |
| 18 | An independent module is a module which is not derived from this |
| 19 | software. The special exception does not apply to any modifications |
| 20 | of the software. |
| 21 | |
| 22 | Not withstanding the above, under no circumstances may you combine |
| 23 | this software in any way with any other Broadcom software provided |
| 24 | under a license other than the GPL, without Broadcom's express prior |
| 25 | written consent. |
| 26 | |
| 27 | :> |
| 28 | */ |
| 29 | |
| 30 | #ifndef _BCMOLT_EON_H_ |
| 31 | #define _BCMOLT_EON_H_ |
| 32 | |
| 33 | #include <bcmos_system.h> |
| 34 | #include <bcmolt_api.h> |
| 35 | #include <bcmolt_model_types.h> |
| 36 | #include <bcmcli.h> |
| 37 | |
| 38 | /* uniquely identifies specific EPON links under management by this application */ |
| 39 | typedef struct |
| 40 | { |
| 41 | bcmolt_devid device_id; |
| 42 | bcmolt_epon_link_key link; |
| 43 | } eon_link_key; |
| 44 | |
| 45 | typedef enum |
| 46 | { |
| 47 | EON_OAM_SET_ID_DPOE, |
| 48 | EON_OAM_SET_ID_BRCM, |
| 49 | EON_OAM_SET_ID_CTC, |
| 50 | |
| 51 | EON_OAM_SET_ID_COUNT |
| 52 | } eon_oam_set_id; |
| 53 | |
| 54 | /* signature of optional callback function used to report outcomes of OAM negotiations */ |
| 55 | typedef void (*bcmolt_eon_result_cb)(void *context, const eon_link_key *link_key, bcmos_errno result); |
| 56 | |
| 57 | typedef struct |
| 58 | { |
| 59 | bcmolt_epon_link_key link_key; |
| 60 | eon_oam_set_id oam_set; |
| 61 | bcmolt_eon_result_cb cb; |
| 62 | void *context; |
| 63 | bcmos_bool is_heartbeat_autostart; |
| 64 | } eon_task_start_data; |
| 65 | |
| 66 | typedef struct |
| 67 | { |
| 68 | bcmolt_epon_link_key link_key; |
| 69 | } eon_task_stop_data; |
| 70 | |
| 71 | typedef struct |
| 72 | { |
| 73 | bcmolt_proxy_rx *rx; |
| 74 | } eon_task_proxy_rx_data; |
| 75 | |
| 76 | typedef union |
| 77 | { |
| 78 | eon_task_start_data start; |
| 79 | eon_task_stop_data stop; |
| 80 | eon_task_proxy_rx_data proxy_rx; |
| 81 | } eon_task_msg_data; |
| 82 | |
| 83 | typedef struct |
| 84 | { |
| 85 | bcmos_msg os_msg; |
| 86 | eon_task_msg_data data; |
| 87 | } eon_task_msg; |
| 88 | |
| 89 | // initialize the EPON OAM negotiation application (should be called as part of user application startup) |
| 90 | extern void bcmolt_user_appl_eon_init(void); |
| 91 | |
| 92 | // process a proxy rx |
| 93 | bcmos_errno bcmolt_user_appl_eon_process_rx(bcmolt_devid device_id, bcmolt_proxy_rx *proxy_rx); |
| 94 | |
| 95 | // initialize EON CLI |
| 96 | void bcmolt_user_appl_eon_cli_init(bcmcli_entry *top_dir); |
| 97 | |
| 98 | #endif |