ath6kl: Bringing in the upstream version

chromeos/drivers/ath6kl/include/hif.h

 //------------------------------------------------------------------------------
 // <copyright file="hif.h" company="Atheros">
-//    Copyright (c) 2004-2008 Atheros Corporation.  All rights reserved.
+//    Copyright (c) 2004-2010 Atheros Corporation.  All rights reserved.
 // 
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License version 2 as
-// published by the Free Software Foundation;
 //
-// Software distributed under the License is distributed on an "AS
-// IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
-// implied. See the License for the specific language governing
-// rights and limitations under the License.
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 //
 //
 //------------------------------------------------------------------------------
 //==============================================================================
 // HIF specific declarations and prototypes
 //
 // Author(s): ="Atheros"
 //==============================================================================
 #ifndef _HIF_H_
 #define _HIF_H_
@@ skipping 196 matching lines @@
  * 
  */
 
 typedef struct {
     A_UINT32    ExtendedAddress;  /* extended address for larger writes */  
     A_UINT32    ExtendedSize;
 } HIF_MBOX_PROPERTIES;
 
 #define HIF_MBOX_FLAG_NO_BUNDLING   (1 << 0)   /* do not allow bundling over the mailbox */
 
+typedef enum _MBOX_BUF_IF_TYPE {
+    MBOX_BUS_IF_SDIO = 0,
+    MBOX_BUS_IF_SPI = 1,    
+} MBOX_BUF_IF_TYPE;
+
 typedef struct {
     A_UINT32 MboxAddresses[4];  /* must be first element for legacy HIFs that return the address in  
                                    and ARRAY of 32-bit words */
     
         /* the following describe extended mailbox properties */
     HIF_MBOX_PROPERTIES MboxProp[4];
         /* if the HIF supports the GMbox extended address region it can report it
          * here, some interfaces cannot support the GMBOX address range and not set this */
     A_UINT32 GMboxAddress;  
     A_UINT32 GMboxSize;
     A_UINT32 Flags;             /* flags to describe mbox behavior or usage */
+    MBOX_BUF_IF_TYPE MboxBusIFType;   /* mailbox bus interface type */
 } HIF_DEVICE_MBOX_INFO;
 
 typedef enum {
     HIF_DEVICE_IRQ_SYNC_ONLY,   /* for HIF implementations that require the DSR to process all
                                    interrupts before returning */
     HIF_DEVICE_IRQ_ASYNC_SYNC,  /* for HIF implementations that allow DSR to process interrupts
                                    using ASYNC I/O (that is HIFAckInterrupt can be called at a
                                    later time */
 } HIF_DEVICE_IRQ_PROCESSING_MODE;
 
@@ skipping 69 matching lines @@
 };
 
 typedef struct osdrv_callbacks {
     void      *context;     /* context to pass for all callbacks except deviceRemovedHandler 
                                the deviceRemovedHandler is only called if the device is claimed */
     A_STATUS (* deviceInsertedHandler)(void *context, void *hif_handle);
     A_STATUS (* deviceRemovedHandler)(void *claimedContext, void *hif_handle);
     A_STATUS (* deviceSuspendHandler)(void *context);
     A_STATUS (* deviceResumeHandler)(void *context);
     A_STATUS (* deviceWakeupHandler)(void *context);  
+    A_STATUS (* devicePowerChangeHandler)(void *context, HIF_DEVICE_POWER_CHANGE_TYPE config);  
 } OSDRV_CALLBACKS;
 
 #define HIF_OTHER_EVENTS     (1 << 0)   /* other interrupts (non-Recv) are pending, host
                                            needs to read the register table to figure out what */
 #define HIF_RECV_MSG_AVAIL   (1 << 1)   /* pending recv packet */
 
 typedef struct _HIF_PENDING_EVENTS_INFO {
     A_UINT32 Events;
     A_UINT32 LookAhead;
     A_UINT32 AvailableRecvBytes;
+#ifdef THREAD_X
+    A_UINT32 Polling;
+    A_UINT32 INT_CAUSE_REG;
+#endif
 } HIF_PENDING_EVENTS_INFO;
 
     /* function to get pending events , some HIF modules use special mechanisms
      * to detect packet available and other interrupts */
 typedef A_STATUS ( *HIF_PENDING_EVENTS_FUNC)(HIF_DEVICE              *device,
                                              HIF_PENDING_EVENTS_INFO *pEvents,
                                              void                    *AsyncContext);
 
 #define HIF_MASK_RECV    TRUE
 #define HIF_UNMASK_RECV  FALSE
@@ skipping 53 matching lines @@
  * the previous interrupt request has been serviced and the all the relevant
  * sources have been cleared. HTC is ready to process more interrupts.
  * This should prevent the bus driver from raising an interrupt unless the
  * previous one has been serviced and acknowledged using the previous API.
  */
 void HIFAckInterrupt(HIF_DEVICE *device);
 
 void HIFMaskInterrupt(HIF_DEVICE *device);
 
 void HIFUnMaskInterrupt(HIF_DEVICE *device);
+ 
+#ifdef THREAD_X
+/*
+ * This set of functions are to be used by the bus driver to notify
+ * the HIF module about various events.
+ * These are not implemented if the bus driver provides an alternative
+ * way for this notification though callbacks for instance.
+ */
+int HIFInsertEventNotify(void);
+
+int HIFRemoveEventNotify(void);
+
+int HIFIRQEventNotify(void);
+
+int HIFRWCompleteEventNotify(void);
+#endif
 
 A_STATUS
 HIFConfigureDevice(HIF_DEVICE *device, HIF_DEVICE_CONFIG_OPCODE opcode,
                    void *config, A_UINT32 configLen);
 
+/* 
+ * This API wait for the remaining MBOX messages to be drained
+ * This should be moved to HTC AR6K layer
+ */
+A_STATUS hifWaitForPendingRecv(HIF_DEVICE *device);
+
 #ifdef __cplusplus
 }
 #endif
 
 #endif /* _HIF_H_ */