mac802154.h

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2012 Siemens AG
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Written by:
 * Pavel Smolenskiy <[email protected]>
 * Maxim Gorbachyov <[email protected]>
 * Dmitry Eremin-Solenikov <[email protected]>
 * Alexander Smirnov <[email protected]>
 */
#ifndef MAC802154_H
#define MAC802154_H

/* mac802154 device private data */
struct mac802154_priv {
    struct ieee802154_dev hw;
    struct ieee802154_ops *ops;

    /* ieee802154 phy */
    struct wpan_phy *phy;

    int open_count;

    /* As in mac80211 slaves list is modified:
     * 1) under the RTNL
     * 2) protected by slaves_mtx;
     * 3) in an RCU manner
     *
     * So atomic readers can use any of this protection methods.
     */
    struct list_head    slaves;
    struct mutex        slaves_mtx;

    /* This one is used for scanning and other jobs not to be interfered
     * with serial driver.
     */
    struct workqueue_struct *dev_workqueue;

    /* SoftMAC device is registered and running. One can add subinterfaces.
     * This flag should be modified under slaves_mtx and RTNL, so you can
     * read them using any of protection methods.
     */
    bool running;
};

#define MAC802154_DEVICE_STOPPED    0x00
#define MAC802154_DEVICE_RUN        0x01

/* Slave interface definition.
 *
 * Slaves represent typical network interfaces available from userspace.
 * Each ieee802154 device/transceiver may have several slaves and able
 * to be associated with several networks at the same time.
 */
struct mac802154_sub_if_data {
    struct list_head list; /* the ieee802154_priv->slaves list */

    struct mac802154_priv *hw;
    struct net_device *dev;

    int type;

    spinlock_t mib_lock;

    __le16 pan_id;
    __le16 short_addr;

    u8 chan;
    u8 page;

    /* MAC BSN field */
    u8 bsn;
    /* MAC DSN field */
    u8 dsn;
};

#define mac802154_to_priv(_hw)  container_of(_hw, struct mac802154_priv, hw)

#define MAC802154_MAX_XMIT_ATTEMPTS 3

#define MAC802154_CHAN_NONE     (~(u8)0) /* No channel is assigned */

extern struct ieee802154_reduced_mlme_ops mac802154_mlme_reduced;
extern struct ieee802154_mlme_ops mac802154_mlme_wpan;

int mac802154_slave_open(struct net_device *dev);
int mac802154_slave_close(struct net_device *dev);

void mac802154_monitors_rx(struct mac802154_priv *priv, struct sk_buff *skb);
void mac802154_monitor_setup(struct net_device *dev);

void mac802154_wpans_rx(struct mac802154_priv *priv, struct sk_buff *skb);
void mac802154_wpan_setup(struct net_device *dev);

netdev_tx_t mac802154_tx(struct mac802154_priv *priv, struct sk_buff *skb,
             u8 page, u8 chan);

/* MIB callbacks */
void mac802154_dev_set_short_addr(struct net_device *dev, u16 val);
u16 mac802154_dev_get_short_addr(const struct net_device *dev);
void mac802154_dev_set_ieee_addr(struct net_device *dev);
u16 mac802154_dev_get_pan_id(const struct net_device *dev);
void mac802154_dev_set_pan_id(struct net_device *dev, u16 val);
void mac802154_dev_set_page_channel(struct net_device *dev, u8 page, u8 chan);

#endif /* MAC802154_H */