1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2018-2019, 2021 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved. 4*5113495bSYour Name * 5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 7*5113495bSYour Name * above copyright notice and this permission notice appear in all 8*5113495bSYour Name * copies. 9*5113495bSYour Name * 10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 18*5113495bSYour Name */ 19*5113495bSYour Name 20*5113495bSYour Name #ifndef __OSIF_VDEV_SYNC_H 21*5113495bSYour Name #define __OSIF_VDEV_SYNC_H 22*5113495bSYour Name 23*5113495bSYour Name #include "linux/device.h" 24*5113495bSYour Name #include "linux/netdevice.h" 25*5113495bSYour Name #include "qdf_types.h" 26*5113495bSYour Name 27*5113495bSYour Name /** 28*5113495bSYour Name * struct osif_vdev_sync - vdev synchronization context 29*5113495bSYour Name * @net_dev: the net_device used as a lookup key 30*5113495bSYour Name * @dsc_vdev: the dsc_vdev used for synchronization 31*5113495bSYour Name * @in_use: indicates if the context is being used 32*5113495bSYour Name */ 33*5113495bSYour Name struct osif_vdev_sync { 34*5113495bSYour Name struct net_device *net_dev; 35*5113495bSYour Name struct dsc_vdev *dsc_vdev; 36*5113495bSYour Name bool in_use; 37*5113495bSYour Name }; 38*5113495bSYour Name 39*5113495bSYour Name /** 40*5113495bSYour Name * osif_vdev_sync_create() - create a vdev synchronization context 41*5113495bSYour Name * @dev: parent device to the vdev 42*5113495bSYour Name * @out_vdev_sync: out parameter for the new synchronization context 43*5113495bSYour Name * 44*5113495bSYour Name * Return: Errno 45*5113495bSYour Name */ 46*5113495bSYour Name qdf_must_check int 47*5113495bSYour Name osif_vdev_sync_create(struct device *dev, 48*5113495bSYour Name struct osif_vdev_sync **out_vdev_sync); 49*5113495bSYour Name 50*5113495bSYour Name /** 51*5113495bSYour Name * osif_vdev_sync_create_and_trans() - create a vdev synchronization context 52*5113495bSYour Name * @dev: parent device to the vdev 53*5113495bSYour Name * @out_vdev_sync: out parameter for the new synchronization context 54*5113495bSYour Name * 55*5113495bSYour Name * For protecting the net_device creation process. 56*5113495bSYour Name * 57*5113495bSYour Name * Return: Errno 58*5113495bSYour Name */ 59*5113495bSYour Name #define osif_vdev_sync_create_and_trans(dev, out_vdev_sync) \ 60*5113495bSYour Name __osif_vdev_sync_create_and_trans(dev, out_vdev_sync, __func__) 61*5113495bSYour Name 62*5113495bSYour Name qdf_must_check int 63*5113495bSYour Name __osif_vdev_sync_create_and_trans(struct device *dev, 64*5113495bSYour Name struct osif_vdev_sync **out_vdev_sync, 65*5113495bSYour Name const char *desc); 66*5113495bSYour Name 67*5113495bSYour Name /** 68*5113495bSYour Name * osif_vdev_sync_destroy() - destroy a vdev synchronization context 69*5113495bSYour Name * @vdev_sync: the context to destroy 70*5113495bSYour Name * 71*5113495bSYour Name * Return: none 72*5113495bSYour Name */ 73*5113495bSYour Name void osif_vdev_sync_destroy(struct osif_vdev_sync *vdev_sync); 74*5113495bSYour Name 75*5113495bSYour Name /** 76*5113495bSYour Name * osif_vdev_sync_register() - register a vdev for operations/transitions 77*5113495bSYour Name * @net_dev: the net_device to use as the operation/transition lookup key 78*5113495bSYour Name * @vdev_sync: the vdev synchronization context to register 79*5113495bSYour Name * 80*5113495bSYour Name * Return: none 81*5113495bSYour Name */ 82*5113495bSYour Name void osif_vdev_sync_register(struct net_device *net_dev, 83*5113495bSYour Name struct osif_vdev_sync *vdev_sync); 84*5113495bSYour Name 85*5113495bSYour Name /** 86*5113495bSYour Name * osif_vdev_sync_unregister() - unregister a vdev for operations/transitions 87*5113495bSYour Name * @net_dev: the net_device originally used to register the vdev_sync context 88*5113495bSYour Name * 89*5113495bSYour Name * Return: the vdev synchronization context that was registered for @net_dev 90*5113495bSYour Name */ 91*5113495bSYour Name struct osif_vdev_sync *osif_vdev_sync_unregister(struct net_device *net_dev); 92*5113495bSYour Name 93*5113495bSYour Name /** 94*5113495bSYour Name * osif_vdev_sync_trans_start() - attempt to start a transition on @net_dev 95*5113495bSYour Name * @net_dev: the net_device to transition 96*5113495bSYour Name * @out_vdev_sync: out parameter for the synchronization context registered with 97*5113495bSYour Name * @net_dev, populated on success 98*5113495bSYour Name * 99*5113495bSYour Name * Return: Errno 100*5113495bSYour Name */ 101*5113495bSYour Name #define osif_vdev_sync_trans_start(net_dev, out_vdev_sync) \ 102*5113495bSYour Name __osif_vdev_sync_trans_start(net_dev, out_vdev_sync, __func__) 103*5113495bSYour Name 104*5113495bSYour Name qdf_must_check int 105*5113495bSYour Name __osif_vdev_sync_trans_start(struct net_device *net_dev, 106*5113495bSYour Name struct osif_vdev_sync **out_vdev_sync, 107*5113495bSYour Name const char *desc); 108*5113495bSYour Name 109*5113495bSYour Name /** 110*5113495bSYour Name * osif_vdev_sync_trans_start_wait() - attempt to start a transition on 111*5113495bSYour Name * @net_dev, blocking if a conflicting transition is in flight 112*5113495bSYour Name * @net_dev: the net_device to transition 113*5113495bSYour Name * @out_vdev_sync: out parameter for the synchronization context registered with 114*5113495bSYour Name * @net_dev, populated on success 115*5113495bSYour Name * 116*5113495bSYour Name * Return: Errno 117*5113495bSYour Name */ 118*5113495bSYour Name #define osif_vdev_sync_trans_start_wait(net_dev, out_vdev_sync) \ 119*5113495bSYour Name __osif_vdev_sync_trans_start_wait(net_dev, out_vdev_sync, __func__) 120*5113495bSYour Name 121*5113495bSYour Name qdf_must_check int 122*5113495bSYour Name __osif_vdev_sync_trans_start_wait(struct net_device *net_dev, 123*5113495bSYour Name struct osif_vdev_sync **out_vdev_sync, 124*5113495bSYour Name const char *desc); 125*5113495bSYour Name 126*5113495bSYour Name /** 127*5113495bSYour Name * osif_vdev_sync_trans_stop() - stop a transition associated with @vdev_sync 128*5113495bSYour Name * @vdev_sync: the synchronization context tracking the transition 129*5113495bSYour Name * 130*5113495bSYour Name * Return: none 131*5113495bSYour Name */ 132*5113495bSYour Name void osif_vdev_sync_trans_stop(struct osif_vdev_sync *vdev_sync); 133*5113495bSYour Name 134*5113495bSYour Name /** 135*5113495bSYour Name * osif_vdev_sync_assert_trans_protected() - assert that @net_dev is currently 136*5113495bSYour Name * protected by a transition 137*5113495bSYour Name * @net_dev: the net_device to check 138*5113495bSYour Name * 139*5113495bSYour Name * Return: none 140*5113495bSYour Name */ 141*5113495bSYour Name void osif_vdev_sync_assert_trans_protected(struct net_device *net_dev); 142*5113495bSYour Name 143*5113495bSYour Name /** 144*5113495bSYour Name * osif_vdev_sync_op_start() - attempt to start an operation on @net_dev 145*5113495bSYour Name * @net_dev: the net_device to operate against 146*5113495bSYour Name * @out_vdev_sync: out parameter for the synchronization context registered with 147*5113495bSYour Name * @net_dev, populated on success 148*5113495bSYour Name * 149*5113495bSYour Name * Return: Errno 150*5113495bSYour Name */ 151*5113495bSYour Name #define osif_vdev_sync_op_start(net_dev, out_vdev_sync) \ 152*5113495bSYour Name __osif_vdev_sync_op_start(net_dev, out_vdev_sync, __func__) 153*5113495bSYour Name 154*5113495bSYour Name qdf_must_check int 155*5113495bSYour Name __osif_vdev_sync_op_start(struct net_device *net_dev, 156*5113495bSYour Name struct osif_vdev_sync **out_vdev_sync, 157*5113495bSYour Name const char *func); 158*5113495bSYour Name 159*5113495bSYour Name /** 160*5113495bSYour Name * osif_vdev_sync_op_stop() - stop an operation associated with @vdev_sync 161*5113495bSYour Name * @vdev_sync: the synchronization context tracking the operation 162*5113495bSYour Name * 163*5113495bSYour Name * Return: none 164*5113495bSYour Name */ 165*5113495bSYour Name #define osif_vdev_sync_op_stop(vdev_sync) \ 166*5113495bSYour Name __osif_vdev_sync_op_stop(vdev_sync, __func__) 167*5113495bSYour Name 168*5113495bSYour Name void __osif_vdev_sync_op_stop(struct osif_vdev_sync *vdev_sync, 169*5113495bSYour Name const char *func); 170*5113495bSYour Name 171*5113495bSYour Name /** 172*5113495bSYour Name * osif_vdev_sync_wait_for_ops() - wait until all @vdev_sync operations complete 173*5113495bSYour Name * @vdev_sync: the synchronization context tracking the operations 174*5113495bSYour Name * 175*5113495bSYour Name * Return: None 176*5113495bSYour Name */ 177*5113495bSYour Name void osif_vdev_sync_wait_for_ops(struct osif_vdev_sync *vdev_sync); 178*5113495bSYour Name 179*5113495bSYour Name /** 180*5113495bSYour Name * osif_vdev_get_cached_cmd() - Get north bound cmd cached during SSR 181*5113495bSYour Name * @vdev_sync: osif vdev sync corresponding to the network interface 182*5113495bSYour Name * 183*5113495bSYour Name * This api will be invoked after completion of SSR re-initialization to get 184*5113495bSYour Name * the last north bound command received during SSR 185*5113495bSYour Name * 186*5113495bSYour Name * Return: North bound command ID 187*5113495bSYour Name */ 188*5113495bSYour Name uint8_t osif_vdev_get_cached_cmd(struct osif_vdev_sync *vdev_sync); 189*5113495bSYour Name 190*5113495bSYour Name /** 191*5113495bSYour Name * osif_vdev_cache_command() - Cache north bound command during SSR 192*5113495bSYour Name * @vdev_sync: osif vdev sync corresponding to the network interface 193*5113495bSYour Name * @cmd_id: North bound command ID 194*5113495bSYour Name * 195*5113495bSYour Name * This api will be invoked when a north bound command is received during SSR 196*5113495bSYour Name * and it should be handled after SSR re-initialization. 197*5113495bSYour Name * 198*5113495bSYour Name * Return: None 199*5113495bSYour Name */ 200*5113495bSYour Name void osif_vdev_cache_command(struct osif_vdev_sync *vdev_sync, uint8_t cmd_id); 201*5113495bSYour Name 202*5113495bSYour Name /** 203*5113495bSYour Name * osif_get_vdev_sync_arr() - Get vdev sync array base pointer 204*5113495bSYour Name * 205*5113495bSYour Name * Return: Base pointer to the vdev sync array 206*5113495bSYour Name */ 207*5113495bSYour Name struct osif_vdev_sync *osif_get_vdev_sync_arr(void); 208*5113495bSYour Name 209*5113495bSYour Name #endif /* __OSIF_VDEV_SYNC_H */ 210*5113495bSYour Name 211