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 BCM_KEEP_ALIVE_H_ |
| 31 | #define BCM_KEEP_ALIVE_H_ |
| 32 | |
| 33 | #include <bcmos_system.h> |
| 34 | #include <bcmolt_conv.h> |
| 35 | |
| 36 | /* Message originator : device or host */ |
| 37 | typedef enum |
| 38 | { |
| 39 | BCM_KEEP_ALIVE_MSG_ORIG_DEVICE, |
| 40 | BCM_KEEP_ALIVE_MSG_ORIG_HOST, |
| 41 | } keep_alive_msg_orig; |
| 42 | |
| 43 | typedef struct |
| 44 | { |
| 45 | char name[MAX_TIMER_NAME_SIZE]; |
| 46 | bcmos_timer timer; |
| 47 | } keep_alive_timer; |
| 48 | |
| 49 | typedef bcmos_errno (*F_bcmos_keep_alive_send_handler)(bcmolt_devid device, bcmolt_msg *msg); |
| 50 | typedef bcmos_errno (*F_bcmos_keep_alive_disconnect_handler)(bcmolt_devid device); |
| 51 | |
| 52 | typedef struct |
| 53 | { |
| 54 | uint32_t last_sent_ka_seq; |
| 55 | uint32_t last_recv_ka_seq; |
| 56 | uint32_t last_recv_ka_timestamp; |
| 57 | uint32_t ka_process_start_ts; |
| 58 | uint32_t ka_interval; |
| 59 | uint32_t ka_tolerance; |
| 60 | keep_alive_msg_orig orig; |
| 61 | bcmolt_devid device; |
| 62 | keep_alive_timer ka_timer; |
| 63 | F_bcmos_keep_alive_disconnect_handler disconnect_handler; |
| 64 | F_bcmos_keep_alive_send_handler send_handler; |
| 65 | } bcmos_keep_alive_info; |
| 66 | |
| 67 | typedef union |
| 68 | { |
| 69 | bcmolt_device_device_keep_alive device; /**< Keep alive message originated at the Device */ |
| 70 | bcmolt_device_host_keep_alive host; /**< Keep alive message originated at the Host */ |
| 71 | } bcmos_keep_alive_msg; |
| 72 | |
| 73 | typedef union |
| 74 | { |
| 75 | bcmolt_device_device_keep_alive_data device; /**< Keep alive message originated at the Device */ |
| 76 | bcmolt_device_host_keep_alive_data host; /**< Keep alive message originated at the Host */ |
| 77 | } bcmos_keep_alive_data_msg; |
| 78 | |
| 79 | BCMOLT_TYPE2STR(keep_alive_msg_orig, extern) |
| 80 | |
| 81 | void keep_alive_rx_handler(const bcmos_keep_alive_data_msg *ka_data_msg, bcmos_keep_alive_info *ka_info); |
| 82 | bcmos_errno create_keep_alive_timer(bcmos_keep_alive_info *ka_info,bcmos_module_id module_id); |
| 83 | void start_keep_alive_process(bcmos_keep_alive_info *ka_info); |
| 84 | void stop_keep_alive_process(bcmos_keep_alive_info *ka_info); |
| 85 | |
| 86 | #endif /* BCM_KEEP_ALIVE_H_ */ |