[deliverable/linux.git] / include / net / cfg802154.h

/*
 * Copyright (C) 2007, 2008, 2009 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.
 *
 * Written by:
 * Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
 */

#ifndef __NET_CFG802154_H
#define __NET_CFG802154_H

#include <linux/netdevice.h>
#include <linux/mutex.h>
#include <linux/bug.h>

/* According to the IEEE 802.15.4 stadard the upper most significant bits of
 * the 32-bit channel bitmaps shall be used as an integer value to specify 32
 * possible channel pages. The lower 27 bits of the channel bit map shall be
 * used as a bit mask to specify channel numbers within a channel page.
 */
#define WPAN_NUM_CHANNELS	27
#define WPAN_NUM_PAGES		32

struct wpan_phy {
	struct mutex pib_lock;

	/*
	 * This is a PIB according to 802.15.4-2011.
	 * We do not provide timing-related variables, as they
	 * aren't used outside of driver
	 */
	u8 current_channel;
	u8 current_page;
	u32 channels_supported[32];
	s8 transmit_power;
	u8 cca_mode;
	u8 min_be;
	u8 max_be;
	u8 csma_retries;
	s8 frame_retries;

	bool lbt;
	s32 cca_ed_level;

	struct device dev;
	int idx;

	struct net_device *(*add_iface)(struct wpan_phy *phy,
					const char *name, int type);
	void (*del_iface)(struct wpan_phy *phy, struct net_device *dev);

	char priv[0] __aligned(NETDEV_ALIGN);
};

#define to_phy(_dev)	container_of(_dev, struct wpan_phy, dev)

struct wpan_phy *wpan_phy_alloc(size_t priv_size);
static inline void wpan_phy_set_dev(struct wpan_phy *phy, struct device *dev)
{
	phy->dev.parent = dev;
}

int wpan_phy_register(struct wpan_phy *phy);
void wpan_phy_unregister(struct wpan_phy *phy);
void wpan_phy_free(struct wpan_phy *phy);
/* Same semantics as for class_for_each_device */
int wpan_phy_for_each(int (*fn)(struct wpan_phy *phy, void *data), void *data);

static inline void *wpan_phy_priv(struct wpan_phy *phy)
{
	BUG_ON(!phy);
	return &phy->priv;
}

struct wpan_phy *wpan_phy_find(const char *str);

static inline void wpan_phy_put(struct wpan_phy *phy)
{
	put_device(&phy->dev);
}

static inline const char *wpan_phy_name(struct wpan_phy *phy)
{
	return dev_name(&phy->dev);
}

#endif /* __NET_CFG802154_H */
Commit	Line	Data
2bfb1070 DES	1	/*
	2	* Copyright (C) 2007, 2008, 2009 Siemens AG
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2
	6	* as published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	11	* GNU General Public License for more details.
	12	*
2bfb1070 DES	13	* Written by:
	14	* Dmitry Eremin-Solenikov <dbaryshkov@gmail.com>
	15	*/
	16
5ad60d36 AA	17	#ifndef __NET_CFG802154_H
5ad60d36 AA	18	#define __NET_CFG802154_H
2bfb1070 DES	19
	20	#include <linux/netdevice.h>
	21	#include <linux/mutex.h>
187f1882	22	#include <linux/bug.h>
2bfb1070	23
0606069d	24	/* According to the IEEE 802.15.4 stadard the upper most significant bits of
	25	* the 32-bit channel bitmaps shall be used as an integer value to specify 32
	26	* possible channel pages. The lower 27 bits of the channel bit map shall be
	27	* used as a bit mask to specify channel numbers within a channel page.
	28	*/
	29	#define WPAN_NUM_CHANNELS 27
	30	#define WPAN_NUM_PAGES 32
	31
2bfb1070 DES	32	struct wpan_phy {
	33	struct mutex pib_lock;
	34
	35	/*
9b2777d6	36	* This is a PIB according to 802.15.4-2011.
2bfb1070 DES	37	* We do not provide timing-related variables, as they
	38	* aren't used outside of driver
	39	*/
	40	u8 current_channel;
	41	u8 current_page;
a0b4a738	42	u32 channels_supported[32];
9b2777d6	43	s8 transmit_power;
2bfb1070	44	u8 cca_mode;
4244db1b PB	45	u8 min_be;
	46	u8 max_be;
	47	u8 csma_retries;
	48	s8 frame_retries;
2bfb1070	49
84dda3c6	50	bool lbt;
6ca00197	51	s32 cca_ed_level;
84dda3c6	52
2bfb1070 DES	53	struct device dev;
	54	int idx;
	55
bb1cafb8	56	struct net_device (add_iface)(struct wpan_phy *phy,
90c049b2	57	const char *name, int type);
bb1cafb8 DES	58	void (del_iface)(struct wpan_phy phy, struct net_device *dev);
bb1cafb8 DES	59
4896167d	60	char priv[0] __aligned(NETDEV_ALIGN);
2bfb1070 DES	61	};
2bfb1070 DES	62
42723448 DES	63	#define to_phy(_dev) container_of(_dev, struct wpan_phy, dev)
42723448 DES	64
2bfb1070	65	struct wpan_phy *wpan_phy_alloc(size_t priv_size);
e9cf356c DES	66	static inline void wpan_phy_set_dev(struct wpan_phy phy, struct device dev)
	67	{
	68	phy->dev.parent = dev;
	69	}
e72740d0	70
e9cf356c	71	int wpan_phy_register(struct wpan_phy *phy);
2bfb1070 DES	72	void wpan_phy_unregister(struct wpan_phy *phy);
2bfb1070 DES	73	void wpan_phy_free(struct wpan_phy *phy);
1c889f4d DES	74	/* Same semantics as for class_for_each_device */
1c889f4d DES	75	int wpan_phy_for_each(int (fn)(struct wpan_phy phy, void data), void data);
2bfb1070 DES	76
	77	static inline void wpan_phy_priv(struct wpan_phy phy)
	78	{
	79	BUG_ON(!phy);
	80	return &phy->priv;
	81	}
	82
	83	struct wpan_phy wpan_phy_find(const char str);
69d9ab96 DES	84
	85	static inline void wpan_phy_put(struct wpan_phy *phy)
	86	{
	87	put_device(&phy->dev);
	88	}
	89
2bfb1070 DES	90	static inline const char wpan_phy_name(struct wpan_phy phy)
	91	{
	92	return dev_name(&phy->dev);
	93	}
5ad60d36 AA	94
5ad60d36 AA	95	#endif /* __NET_CFG802154_H */