iwlagn: cosmetics in iwl-trans.h
[pandora-kernel.git] / drivers / net / wireless / iwlwifi / iwl-trans.h
index 111acca..c92c9fe 100644 (file)
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
  *****************************************************************************/
-static inline int trans_rx_init(struct iwl_priv *priv)
+#ifndef __iwl_trans_h__
+#define __iwl_trans_h__
+
+#include <linux/debugfs.h>
+#include <linux/skbuff.h>
+
+#include "iwl-shared.h"
+#include "iwl-commands.h"
+
+ /*This file includes the declaration that are exported from the transport
+ * layer */
+
+struct iwl_priv;
+struct iwl_rxon_context;
+struct iwl_host_cmd;
+struct iwl_shared;
+struct iwl_device_cmd;
+
+/**
+ * struct iwl_trans_ops - transport specific operations
+ * @alloc: allocates the meta data (not the queues themselves)
+ * @request_irq: requests IRQ - will be called before the FW load in probe flow
+ * @start_device: allocates and inits all the resources for the transport
+ *                layer.
+ * @prepare_card_hw: claim the ownership on the HW. Will be called during
+ *                   probe.
+ * @tx_start: starts and configures all the Tx fifo - usually done once the fw
+ *           is alive.
+ * @wake_any_queue: wake all the queues of a specfic context IWL_RXON_CTX_*
+ * @stop_device:stops the whole device (embedded CPU put to reset)
+ * @send_cmd:send a host command
+ * @send_cmd_pdu:send a host command: flags can be CMD_*
+ * @tx: send an skb
+ * @reclaim: free packet until ssn. Returns a list of freed packets.
+ * @tx_agg_alloc: allocate resources for a TX BA session
+ * @tx_agg_setup: setup a tx queue for AMPDU - will be called once the HW is
+ *                 ready and a successful ADDBA response has been received.
+ * @tx_agg_disable: de-configure a Tx queue to send AMPDUs
+ * @kick_nic: remove the RESET from the embedded CPU and let it run
+ * @free: release all the ressource for the transport layer itself such as
+ *        irq, tasklet etc...
+ * @dbgfs_register: add the dbgfs files under this directory. Files will be
+ *     automatically deleted.
+ * @suspend: stop the device unless WoWLAN is configured
+ * @resume: resume activity of the device
+ */
+struct iwl_trans_ops {
+
+       struct iwl_trans *(*alloc)(struct iwl_shared *shrd);
+       int (*request_irq)(struct iwl_trans *iwl_trans);
+       int (*start_device)(struct iwl_trans *trans);
+       int (*prepare_card_hw)(struct iwl_trans *trans);
+       void (*stop_device)(struct iwl_trans *trans);
+       void (*tx_start)(struct iwl_trans *trans);
+
+       void (*wake_any_queue)(struct iwl_trans *trans, u8 ctx);
+
+       int (*send_cmd)(struct iwl_trans *trans, struct iwl_host_cmd *cmd);
+
+       int (*send_cmd_pdu)(struct iwl_trans *trans, u8 id, u32 flags, u16 len,
+                    const void *data);
+       int (*tx)(struct iwl_trans *trans, struct sk_buff *skb,
+               struct iwl_device_cmd *dev_cmd, u8 ctx, u8 sta_id);
+       void (*reclaim)(struct iwl_trans *trans, int sta_id, int tid,
+                       int txq_id, int ssn, u32 status,
+                       struct sk_buff_head *skbs);
+
+       int (*tx_agg_disable)(struct iwl_trans *trans,
+                             enum iwl_rxon_context_id ctx, int sta_id,
+                             int tid);
+       int (*tx_agg_alloc)(struct iwl_trans *trans,
+                           enum iwl_rxon_context_id ctx, int sta_id, int tid,
+                           u16 *ssn);
+       void (*tx_agg_setup)(struct iwl_trans *trans,
+                            enum iwl_rxon_context_id ctx, int sta_id, int tid,
+                            int frame_limit);
+
+       void (*kick_nic)(struct iwl_trans *trans);
+
+       void (*free)(struct iwl_trans *trans);
+
+       int (*dbgfs_register)(struct iwl_trans *trans, struct dentry* dir);
+       int (*suspend)(struct iwl_trans *trans);
+       int (*resume)(struct iwl_trans *trans);
+};
+
+/**
+ * struct iwl_trans - transport common data
+ * @ops - pointer to iwl_trans_ops
+ * @shrd - pointer to iwl_shared which holds shared data from the upper layer
+ * @hcmd_lock: protects HCMD
+ */
+struct iwl_trans {
+       const struct iwl_trans_ops *ops;
+       struct iwl_shared *shrd;
+       spinlock_t hcmd_lock;
+
+       /* pointer to trans specific struct */
+       /*Ensure that this pointer will always be aligned to sizeof pointer */
+       char trans_specific[0] __attribute__((__aligned__(sizeof(void *))));
+};
+
+static inline int iwl_trans_request_irq(struct iwl_trans *trans)
 {
-       return priv->trans.ops->rx_init(priv);
+       return trans->ops->request_irq(trans);
 }
 
-static inline int trans_rx_stop(struct iwl_priv *priv)
+static inline int iwl_trans_start_device(struct iwl_trans *trans)
 {
-       return priv->trans.ops->rx_stop(priv);
+       return trans->ops->start_device(trans);
 }
 
-static inline void trans_rx_free(struct iwl_priv *priv)
+static inline int iwl_trans_prepare_card_hw(struct iwl_trans *trans)
 {
-       priv->trans.ops->rx_free(priv);
+       return trans->ops->prepare_card_hw(trans);
 }
 
-static inline int trans_tx_init(struct iwl_priv *priv)
+static inline void iwl_trans_stop_device(struct iwl_trans *trans)
 {
-       return priv->trans.ops->tx_init(priv);
+       trans->ops->stop_device(trans);
 }
 
-static inline int trans_tx_stop(struct iwl_priv *priv)
+static inline void iwl_trans_tx_start(struct iwl_trans *trans)
 {
-       return priv->trans.ops->tx_stop(priv);
+       trans->ops->tx_start(trans);
 }
 
-static inline void trans_tx_free(struct iwl_priv *priv)
+static inline void iwl_trans_wake_any_queue(struct iwl_trans *trans, u8 ctx)
 {
-       priv->trans.ops->tx_free(priv);
+       trans->ops->wake_any_queue(trans, ctx);
 }
 
-static inline int trans_send_cmd(struct iwl_priv *priv,
+
+static inline int iwl_trans_send_cmd(struct iwl_trans *trans,
                                struct iwl_host_cmd *cmd)
 {
-       return priv->trans.ops->send_cmd(priv, cmd);
+       return trans->ops->send_cmd(trans, cmd);
+}
+
+static inline int iwl_trans_send_cmd_pdu(struct iwl_trans *trans, u8 id,
+                                       u32 flags, u16 len, const void *data)
+{
+       return trans->ops->send_cmd_pdu(trans, id, flags, len, data);
+}
+
+static inline int iwl_trans_tx(struct iwl_trans *trans, struct sk_buff *skb,
+               struct iwl_device_cmd *dev_cmd, u8 ctx, u8 sta_id)
+{
+       return trans->ops->tx(trans, skb, dev_cmd, ctx, sta_id);
 }
 
-static inline int trans_send_cmd_pdu(struct iwl_priv *priv, u8 id, u32 flags,
-                                       u16 len, const void *data)
+static inline void iwl_trans_reclaim(struct iwl_trans *trans, int sta_id,
+                                int tid, int txq_id, int ssn, u32 status,
+                                struct sk_buff_head *skbs)
 {
-       return priv->trans.ops->send_cmd_pdu(priv, id, flags, len, data);
+       trans->ops->reclaim(trans, sta_id, tid, txq_id, ssn, status, skbs);
 }
 
-void iwl_trans_register(struct iwl_trans *trans);
+static inline int iwl_trans_tx_agg_disable(struct iwl_trans *trans,
+                                           enum iwl_rxon_context_id ctx,
+                                           int sta_id, int tid)
+{
+       return trans->ops->tx_agg_disable(trans, ctx, sta_id, tid);
+}
+
+static inline int iwl_trans_tx_agg_alloc(struct iwl_trans *trans,
+                                        enum iwl_rxon_context_id ctx,
+                                        int sta_id, int tid, u16 *ssn)
+{
+       return trans->ops->tx_agg_alloc(trans, ctx, sta_id, tid, ssn);
+}
+
+
+static inline void iwl_trans_tx_agg_setup(struct iwl_trans *trans,
+                                          enum iwl_rxon_context_id ctx,
+                                          int sta_id, int tid,
+                                          int frame_limit)
+{
+       trans->ops->tx_agg_setup(trans, ctx, sta_id, tid, frame_limit);
+}
+
+static inline void iwl_trans_kick_nic(struct iwl_trans *trans)
+{
+       trans->ops->kick_nic(trans);
+}
+
+static inline void iwl_trans_free(struct iwl_trans *trans)
+{
+       trans->ops->free(trans);
+}
+
+static inline int iwl_trans_dbgfs_register(struct iwl_trans *trans,
+                                           struct dentry *dir)
+{
+       return trans->ops->dbgfs_register(trans, dir);
+}
+
+static inline int iwl_trans_suspend(struct iwl_trans *trans)
+{
+       return trans->ops->suspend(trans);
+}
+
+static inline int iwl_trans_resume(struct iwl_trans *trans)
+{
+       return trans->ops->resume(trans);
+}
+
+/*****************************************************
+* Transport layers implementations
+******************************************************/
+extern const struct iwl_trans_ops trans_ops_pcie;
+
+#endif /* __iwl_trans_h__ */