release/src-rt-6.x.4708/shared/bcm_notif_priv.h

   1 /*
   2  * Private header file for event-component data structure and API
   3  *
   4  * Copyright (C) 2012, Broadcom Corporation
   5  * All Rights Reserved.
   6  *
   7  * This is UNPUBLISHED PROPRIETARY SOURCE CODE of Broadcom Corporation;
   8  * the contents of this file may not be disclosed to third parties, copied
   9  * or duplicated in any form, in whole or in part, without the prior
  10  * written permission of Broadcom Corporation.
  11  *
  12  * $Id$
  13  */
  14
  15 /*
  16  *
  17  *  Here is a picture of the data structure that's maintained.
  18  *  The list is circular for efficiency: FIFO insert is constant time.
  19  *  It's traversed FIFO to signal interest.
  20  *  Any client may ask to be removed.
  21  *
  22  *
  23  *  --------------------------------------------+
  24  *  |                                           |
  25  *  |  +-------+      +-------+      +-------+  |
  26  *  +->| x c n |----->| x c n |----->| x c n |---
  27  *     +-------+      +-------+      +-------+
  28  *                                   ^
  29  *                                   |
  30  *                                +------+
  31  *                       listp--->| tail |
  32  *                                +------+
  33  *
  34  *
  35  *        x is client passthru data for notifications
  36  *        c is the client callback
  37  *        n is a "next" pointer of the list
  38  *        tail is the server's pointer to the list.
  39  *
  40  * Copyright (C) 2012, Broadcom Corporation
  41  * All Rights Reserved.
  42  *
  43  * This is UNPUBLISHED PROPRIETARY SOURCE CODE of Broadcom Corporation;
  44  * the contents of this file may not be disclosed to third parties, copied
  45  * or duplicated in any form, in whole or in part, without the prior
  46  * written permission of Broadcom Corporation.
  47  */
  48
  49 #ifndef BCM_NOTIF_PRIV_H
  50 #define BCM_NOTIF_PRIV_H 1
  51
  52 #include <osl.h>
  53 #include <bcm_notif_pub.h>
  54 #include <bcm_mpool_pub.h>
  55
  56
  57 /* Global notifier module state */
  58 struct bcm_notif_module {
  59
  60         /* Operating system handle. */
  61         osl_t           *osh;
  62
  63         /* Memory pool manager handle. */
  64         bcm_mpm_mgr_h   mpm;
  65
  66         /* Memory pool for server notifier objects. */
  67         bcm_mp_pool_h   server_mem_pool;
  68
  69         /* Memory pool for client request objects. */
  70         bcm_mp_pool_h   client_mem_pool;
  71 };
  72
  73
  74 /*
  75  * Private helper type for nodes in the linked list of client registrations
  76  */
  77 struct bcm_notif_client_request {
  78         bcm_notif_client_data           passthru;
  79         bcm_notif_client_callback       callback;
  80         struct bcm_notif_client_request *next;
  81 };
  82
  83 /*
  84  * This type defines the overall list. The list is kept circular. This way
  85  * We can insert to tail easily, and invoke client callbacks in exactly the same
  86  * order in which they express interest.
  87  */
  88 struct bcm_notif_list_struct {
  89         /* Circular list of client requests. */
  90         struct bcm_notif_client_request *tail;
  91
  92         /* Pointer to global notif state. */
  93         bcm_notif_module_t              *notif_module;
  94
  95         /* Used to ensure that nested events do not occur, and that list operations
  96          * are not performed within client callbacks.
  97          */
  98         bool                            allow_list_operations;
  99 };
 100
 101 #endif /* BCM_NOTIF_PRIV_H */