Merge git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb-2.6
* git://git.kernel.org/pub/scm/linux/kernel/git/gregkh/usb-2.6: (123 commits) wimax/i2400m: add CREDITS and MAINTAINERS entries wimax: export linux/wimax.h and linux/wimax/i2400m.h with headers_install i2400m: Makefile and Kconfig i2400m/SDIO: TX and RX path backends i2400m/SDIO: firmware upload backend i2400m/SDIO: probe/disconnect, dev init/shutdown and reset backends i2400m/SDIO: header for the SDIO subdriver i2400m/USB: TX and RX path backends i2400m/USB: firmware upload backend i2400m/USB: probe/disconnect, dev init/shutdown and reset backends i2400m/USB: header for the USB bus driver i2400m: debugfs controls i2400m: various functions for device management i2400m: RX and TX data/control paths i2400m: firmware loading and bootrom initialization i2400m: linkage to the networking stack i2400m: Generic probe/disconnect, reset and message passing i2400m: host/device procotol and core driver definitions i2400m: documentation and instructions for usage wimax: Makefile, Kconfig and docbook linkage for the stack ...
This commit is contained in:
commit
7c7758f99d
186 changed files with 28290 additions and 1398 deletions
|
|
@ -371,3 +371,5 @@ unifdef-y += xattr.h
|
|||
unifdef-y += xfrm.h
|
||||
|
||||
objhdr-y += version.h
|
||||
header-y += wimax.h
|
||||
header-y += wimax/
|
||||
|
|
|
|||
|
|
@ -63,6 +63,8 @@ struct dentry *debugfs_create_x16(const char *name, mode_t mode,
|
|||
struct dentry *parent, u16 *value);
|
||||
struct dentry *debugfs_create_x32(const char *name, mode_t mode,
|
||||
struct dentry *parent, u32 *value);
|
||||
struct dentry *debugfs_create_size_t(const char *name, mode_t mode,
|
||||
struct dentry *parent, size_t *value);
|
||||
struct dentry *debugfs_create_bool(const char *name, mode_t mode,
|
||||
struct dentry *parent, u32 *value);
|
||||
|
||||
|
|
|
|||
7
include/linux/oxu210hp.h
Normal file
7
include/linux/oxu210hp.h
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
/* platform data for the OXU210HP HCD */
|
||||
|
||||
struct oxu210hp_platform_data {
|
||||
unsigned int bus16:1;
|
||||
unsigned int use_hcd_otg:1;
|
||||
unsigned int use_hcd_sph:1;
|
||||
};
|
||||
|
|
@ -108,6 +108,7 @@ enum usb_interface_condition {
|
|||
* (in probe()), bound to a driver, or unbinding (in disconnect())
|
||||
* @is_active: flag set when the interface is bound and not suspended.
|
||||
* @sysfs_files_created: sysfs attributes exist
|
||||
* @ep_devs_created: endpoint child pseudo-devices exist
|
||||
* @unregistering: flag set when the interface is being unregistered
|
||||
* @needs_remote_wakeup: flag set when the driver requires remote-wakeup
|
||||
* capability during autosuspend.
|
||||
|
|
@ -120,6 +121,11 @@ enum usb_interface_condition {
|
|||
* to the sysfs representation for that device.
|
||||
* @pm_usage_cnt: PM usage counter for this interface; autosuspend is not
|
||||
* allowed unless the counter is 0.
|
||||
* @reset_ws: Used for scheduling resets from atomic context.
|
||||
* @reset_running: set to 1 if the interface is currently running a
|
||||
* queued reset so that usb_cancel_queued_reset() doesn't try to
|
||||
* remove from the workqueue when running inside the worker
|
||||
* thread. See __usb_queue_reset_device().
|
||||
*
|
||||
* USB device drivers attach to interfaces on a physical device. Each
|
||||
* interface encapsulates a single high level function, such as feeding
|
||||
|
|
@ -164,14 +170,17 @@ struct usb_interface {
|
|||
enum usb_interface_condition condition; /* state of binding */
|
||||
unsigned is_active:1; /* the interface is not suspended */
|
||||
unsigned sysfs_files_created:1; /* the sysfs attributes exist */
|
||||
unsigned ep_devs_created:1; /* endpoint "devices" exist */
|
||||
unsigned unregistering:1; /* unregistration is in progress */
|
||||
unsigned needs_remote_wakeup:1; /* driver requires remote wakeup */
|
||||
unsigned needs_altsetting0:1; /* switch to altsetting 0 is pending */
|
||||
unsigned needs_binding:1; /* needs delayed unbind/rebind */
|
||||
unsigned reset_running:1;
|
||||
|
||||
struct device dev; /* interface specific device info */
|
||||
struct device *usb_dev;
|
||||
int pm_usage_cnt; /* usage counter for autosuspend */
|
||||
struct work_struct reset_ws; /* for resets in atomic context */
|
||||
};
|
||||
#define to_usb_interface(d) container_of(d, struct usb_interface, dev)
|
||||
#define interface_to_usbdev(intf) \
|
||||
|
|
@ -329,7 +338,7 @@ struct usb_bus {
|
|||
#endif
|
||||
struct device *dev; /* device for this bus */
|
||||
|
||||
#if defined(CONFIG_USB_MON)
|
||||
#if defined(CONFIG_USB_MON) || defined(CONFIG_USB_MON_MODULE)
|
||||
struct mon_bus *mon_bus; /* non-null when associated */
|
||||
int monitored; /* non-zero when monitored */
|
||||
#endif
|
||||
|
|
@ -398,6 +407,7 @@ struct usb_tt;
|
|||
* @urbnum: number of URBs submitted for the whole device
|
||||
* @active_duration: total time device is not suspended
|
||||
* @autosuspend: for delayed autosuspends
|
||||
* @autoresume: for autoresumes requested while in_interrupt
|
||||
* @pm_mutex: protects PM operations
|
||||
* @last_busy: time of last use
|
||||
* @autosuspend_delay: in jiffies
|
||||
|
|
@ -476,6 +486,7 @@ struct usb_device {
|
|||
|
||||
#ifdef CONFIG_PM
|
||||
struct delayed_work autosuspend;
|
||||
struct work_struct autoresume;
|
||||
struct mutex pm_mutex;
|
||||
|
||||
unsigned long last_busy;
|
||||
|
|
@ -505,6 +516,7 @@ extern int usb_lock_device_for_reset(struct usb_device *udev,
|
|||
|
||||
/* USB port reset for device reinitialization */
|
||||
extern int usb_reset_device(struct usb_device *dev);
|
||||
extern void usb_queue_reset_device(struct usb_interface *dev);
|
||||
|
||||
extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
|
||||
|
||||
|
|
@ -513,6 +525,8 @@ extern struct usb_device *usb_find_device(u16 vendor_id, u16 product_id);
|
|||
extern int usb_autopm_set_interface(struct usb_interface *intf);
|
||||
extern int usb_autopm_get_interface(struct usb_interface *intf);
|
||||
extern void usb_autopm_put_interface(struct usb_interface *intf);
|
||||
extern int usb_autopm_get_interface_async(struct usb_interface *intf);
|
||||
extern void usb_autopm_put_interface_async(struct usb_interface *intf);
|
||||
|
||||
static inline void usb_autopm_enable(struct usb_interface *intf)
|
||||
{
|
||||
|
|
@ -539,8 +553,13 @@ static inline int usb_autopm_set_interface(struct usb_interface *intf)
|
|||
static inline int usb_autopm_get_interface(struct usb_interface *intf)
|
||||
{ return 0; }
|
||||
|
||||
static inline int usb_autopm_get_interface_async(struct usb_interface *intf)
|
||||
{ return 0; }
|
||||
|
||||
static inline void usb_autopm_put_interface(struct usb_interface *intf)
|
||||
{ }
|
||||
static inline void usb_autopm_put_interface_async(struct usb_interface *intf)
|
||||
{ }
|
||||
static inline void usb_autopm_enable(struct usb_interface *intf)
|
||||
{ }
|
||||
static inline void usb_autopm_disable(struct usb_interface *intf)
|
||||
|
|
@ -1050,7 +1069,7 @@ struct usb_device_driver {
|
|||
void (*disconnect) (struct usb_device *udev);
|
||||
|
||||
int (*suspend) (struct usb_device *udev, pm_message_t message);
|
||||
int (*resume) (struct usb_device *udev);
|
||||
int (*resume) (struct usb_device *udev, pm_message_t message);
|
||||
struct usbdrv_wrap drvwrap;
|
||||
unsigned int supports_autosuspend:1;
|
||||
};
|
||||
|
|
@ -1321,7 +1340,7 @@ struct urb {
|
|||
struct kref kref; /* reference count of the URB */
|
||||
void *hcpriv; /* private data for host controller */
|
||||
atomic_t use_count; /* concurrent submissions counter */
|
||||
u8 reject; /* submissions will fail */
|
||||
atomic_t reject; /* submissions will fail */
|
||||
int unlinked; /* unlink error code */
|
||||
|
||||
/* public: documented fields in the urb that can be used by drivers */
|
||||
|
|
@ -1466,6 +1485,7 @@ extern void usb_poison_urb(struct urb *urb);
|
|||
extern void usb_unpoison_urb(struct urb *urb);
|
||||
extern void usb_kill_anchored_urbs(struct usb_anchor *anchor);
|
||||
extern void usb_poison_anchored_urbs(struct usb_anchor *anchor);
|
||||
extern void usb_unpoison_anchored_urbs(struct usb_anchor *anchor);
|
||||
extern void usb_unlink_anchored_urbs(struct usb_anchor *anchor);
|
||||
extern void usb_anchor_urb(struct urb *urb, struct usb_anchor *anchor);
|
||||
extern void usb_unanchor_urb(struct urb *urb);
|
||||
|
|
@ -1722,10 +1742,6 @@ extern void usb_unregister_notify(struct notifier_block *nb);
|
|||
|
||||
#define err(format, arg...) printk(KERN_ERR KBUILD_MODNAME ": " \
|
||||
format "\n" , ## arg)
|
||||
#define info(format, arg...) printk(KERN_INFO KBUILD_MODNAME ": " \
|
||||
format "\n" , ## arg)
|
||||
#define warn(format, arg...) printk(KERN_WARNING KBUILD_MODNAME ": " \
|
||||
format "\n" , ## arg)
|
||||
|
||||
#endif /* __KERNEL__ */
|
||||
|
||||
|
|
|
|||
|
|
@ -28,17 +28,17 @@ struct wusb_am_attr {
|
|||
};
|
||||
|
||||
/* Different fields defined by the spec */
|
||||
#define WUSB_AR_AssociationTypeId { .id = 0x0000, .len = 2 }
|
||||
#define WUSB_AR_AssociationSubTypeId { .id = 0x0001, .len = 2 }
|
||||
#define WUSB_AR_Length { .id = 0x0002, .len = 4 }
|
||||
#define WUSB_AR_AssociationStatus { .id = 0x0004, .len = 4 }
|
||||
#define WUSB_AR_LangID { .id = 0x0008, .len = 2 }
|
||||
#define WUSB_AR_DeviceFriendlyName { .id = 0x000b, .len = 64 } /* max */
|
||||
#define WUSB_AR_HostFriendlyName { .id = 0x000c, .len = 64 } /* max */
|
||||
#define WUSB_AR_CHID { .id = 0x1000, .len = 16 }
|
||||
#define WUSB_AR_CDID { .id = 0x1001, .len = 16 }
|
||||
#define WUSB_AR_ConnectionContext { .id = 0x1002, .len = 48 }
|
||||
#define WUSB_AR_BandGroups { .id = 0x1004, .len = 2 }
|
||||
#define WUSB_AR_AssociationTypeId { .id = cpu_to_le16(0x0000), .len = cpu_to_le16(2) }
|
||||
#define WUSB_AR_AssociationSubTypeId { .id = cpu_to_le16(0x0001), .len = cpu_to_le16(2) }
|
||||
#define WUSB_AR_Length { .id = cpu_to_le16(0x0002), .len = cpu_to_le16(4) }
|
||||
#define WUSB_AR_AssociationStatus { .id = cpu_to_le16(0x0004), .len = cpu_to_le16(4) }
|
||||
#define WUSB_AR_LangID { .id = cpu_to_le16(0x0008), .len = cpu_to_le16(2) }
|
||||
#define WUSB_AR_DeviceFriendlyName { .id = cpu_to_le16(0x000b), .len = cpu_to_le16(64) } /* max */
|
||||
#define WUSB_AR_HostFriendlyName { .id = cpu_to_le16(0x000c), .len = cpu_to_le16(64) } /* max */
|
||||
#define WUSB_AR_CHID { .id = cpu_to_le16(0x1000), .len = cpu_to_le16(16) }
|
||||
#define WUSB_AR_CDID { .id = cpu_to_le16(0x1001), .len = cpu_to_le16(16) }
|
||||
#define WUSB_AR_ConnectionContext { .id = cpu_to_le16(0x1002), .len = cpu_to_le16(48) }
|
||||
#define WUSB_AR_BandGroups { .id = cpu_to_le16(0x1004), .len = cpu_to_le16(2) }
|
||||
|
||||
/* CBAF Control Requests (AMS1.0[T4-1] */
|
||||
enum {
|
||||
|
|
|
|||
30
include/linux/usb/gpio_vbus.h
Normal file
30
include/linux/usb/gpio_vbus.h
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
/*
|
||||
* A simple GPIO VBUS sensing driver for B peripheral only devices
|
||||
* with internal transceivers.
|
||||
* Optionally D+ pullup can be controlled by a second GPIO.
|
||||
*
|
||||
* Copyright (c) 2008 Philipp Zabel <philipp.zabel@gmail.com>
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* struct gpio_vbus_mach_info - configuration for gpio_vbus
|
||||
* @gpio_vbus: VBUS sensing GPIO
|
||||
* @gpio_pullup: optional D+ or D- pullup GPIO (else negative/invalid)
|
||||
* @gpio_vbus_inverted: true if gpio_vbus is active low
|
||||
* @gpio_pullup_inverted: true if gpio_pullup is active low
|
||||
*
|
||||
* The VBUS sensing GPIO should have a pulldown, which will normally be
|
||||
* part of a resistor ladder turning a 4.0V-5.25V level on VBUS into a
|
||||
* value the GPIO detects as active. Some systems will use comparators.
|
||||
*/
|
||||
struct gpio_vbus_mach_info {
|
||||
int gpio_vbus;
|
||||
int gpio_pullup;
|
||||
bool gpio_vbus_inverted;
|
||||
bool gpio_pullup_inverted;
|
||||
};
|
||||
|
|
@ -47,6 +47,11 @@ struct musb_hdrc_config {
|
|||
u8 ram_bits; /* ram address size */
|
||||
|
||||
struct musb_hdrc_eps_bits *eps_bits;
|
||||
#ifdef CONFIG_BLACKFIN
|
||||
/* A GPIO controlling VRSEL in Blackfin */
|
||||
unsigned int gpio_vrsel;
|
||||
#endif
|
||||
|
||||
};
|
||||
|
||||
struct musb_hdrc_platform_data {
|
||||
|
|
|
|||
|
|
@ -84,6 +84,7 @@ extern int otg_set_transceiver(struct otg_transceiver *);
|
|||
|
||||
/* for usb host and peripheral controller drivers */
|
||||
extern struct otg_transceiver *otg_get_transceiver(void);
|
||||
extern void otg_put_transceiver(struct otg_transceiver *);
|
||||
|
||||
static inline int
|
||||
otg_start_hnp(struct otg_transceiver *otg)
|
||||
|
|
|
|||
|
|
@ -52,8 +52,11 @@
|
|||
US_FLAG(MAX_SECTORS_MIN,0x00002000) \
|
||||
/* Sets max_sectors to arch min */ \
|
||||
US_FLAG(BULK_IGNORE_TAG,0x00004000) \
|
||||
/* Ignore tag mismatch in bulk operations */
|
||||
|
||||
/* Ignore tag mismatch in bulk operations */ \
|
||||
US_FLAG(SANE_SENSE, 0x00008000) \
|
||||
/* Sane Sense (> 18 bytes) */ \
|
||||
US_FLAG(CAPACITY_OK, 0x00010000) \
|
||||
/* READ CAPACITY response is correct */
|
||||
|
||||
#define US_FLAG(name, value) US_FL_##name = value ,
|
||||
enum { US_DO_ALL_FLAGS };
|
||||
|
|
|
|||
234
include/linux/wimax.h
Normal file
234
include/linux/wimax.h
Normal file
|
|
@ -0,0 +1,234 @@
|
|||
/*
|
||||
* Linux WiMax
|
||||
* API for user space
|
||||
*
|
||||
*
|
||||
* Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* * Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* * Neither the name of Intel Corporation nor the names of its
|
||||
* contributors may be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*
|
||||
* Intel Corporation <linux-wimax@intel.com>
|
||||
* Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
|
||||
* - Initial implementation
|
||||
*
|
||||
*
|
||||
* This file declares the user/kernel protocol that is spoken over
|
||||
* Generic Netlink, as well as any type declaration that is to be used
|
||||
* by kernel and user space.
|
||||
*
|
||||
* It is intended for user space to clone it verbatim to use it as a
|
||||
* primary reference for definitions.
|
||||
*
|
||||
* Stuff intended for kernel usage as well as full protocol and stack
|
||||
* documentation is rooted in include/net/wimax.h.
|
||||
*/
|
||||
|
||||
#ifndef __LINUX__WIMAX_H__
|
||||
#define __LINUX__WIMAX_H__
|
||||
|
||||
#include <linux/types.h>
|
||||
|
||||
enum {
|
||||
/**
|
||||
* Version of the interface (unsigned decimal, MMm, max 25.5)
|
||||
* M - Major: change if removing or modifying an existing call.
|
||||
* m - minor: change when adding a new call
|
||||
*/
|
||||
WIMAX_GNL_VERSION = 00,
|
||||
/* Generic NetLink attributes */
|
||||
WIMAX_GNL_ATTR_INVALID = 0x00,
|
||||
WIMAX_GNL_ATTR_MAX = 10,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* Generic NetLink operations
|
||||
*
|
||||
* Most of these map to an API call; _OP_ stands for operation, _RP_
|
||||
* for reply and _RE_ for report (aka: signal).
|
||||
*/
|
||||
enum {
|
||||
WIMAX_GNL_OP_MSG_FROM_USER, /* User to kernel message */
|
||||
WIMAX_GNL_OP_MSG_TO_USER, /* Kernel to user message */
|
||||
WIMAX_GNL_OP_RFKILL, /* Run wimax_rfkill() */
|
||||
WIMAX_GNL_OP_RESET, /* Run wimax_rfkill() */
|
||||
WIMAX_GNL_RE_STATE_CHANGE, /* Report: status change */
|
||||
};
|
||||
|
||||
|
||||
/* Message from user / to user */
|
||||
enum {
|
||||
WIMAX_GNL_MSG_IFIDX = 1,
|
||||
WIMAX_GNL_MSG_PIPE_NAME,
|
||||
WIMAX_GNL_MSG_DATA,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* wimax_rfkill()
|
||||
*
|
||||
* The state of the radio (ON/OFF) is mapped to the rfkill subsystem's
|
||||
* switch state (DISABLED/ENABLED).
|
||||
*/
|
||||
enum wimax_rf_state {
|
||||
WIMAX_RF_OFF = 0, /* Radio is off, rfkill on/enabled */
|
||||
WIMAX_RF_ON = 1, /* Radio is on, rfkill off/disabled */
|
||||
WIMAX_RF_QUERY = 2,
|
||||
};
|
||||
|
||||
/* Attributes */
|
||||
enum {
|
||||
WIMAX_GNL_RFKILL_IFIDX = 1,
|
||||
WIMAX_GNL_RFKILL_STATE,
|
||||
};
|
||||
|
||||
|
||||
/* Attributes for wimax_reset() */
|
||||
enum {
|
||||
WIMAX_GNL_RESET_IFIDX = 1,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* Attributes for the Report State Change
|
||||
*
|
||||
* For now we just have the old and new states; new attributes might
|
||||
* be added later on.
|
||||
*/
|
||||
enum {
|
||||
WIMAX_GNL_STCH_IFIDX = 1,
|
||||
WIMAX_GNL_STCH_STATE_OLD,
|
||||
WIMAX_GNL_STCH_STATE_NEW,
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* enum wimax_st - The different states of a WiMAX device
|
||||
* @__WIMAX_ST_NULL: The device structure has been allocated and zeroed,
|
||||
* but still wimax_dev_add() hasn't been called. There is no state.
|
||||
*
|
||||
* @WIMAX_ST_DOWN: The device has been registered with the WiMAX and
|
||||
* networking stacks, but it is not initialized (normally that is
|
||||
* done with 'ifconfig DEV up' [or equivalent], which can upload
|
||||
* firmware and enable communications with the device).
|
||||
* In this state, the device is powered down and using as less
|
||||
* power as possible.
|
||||
* This state is the default after a call to wimax_dev_add(). It
|
||||
* is ok to have drivers move directly to %WIMAX_ST_UNINITIALIZED
|
||||
* or %WIMAX_ST_RADIO_OFF in _probe() after the call to
|
||||
* wimax_dev_add().
|
||||
* It is recommended that the driver leaves this state when
|
||||
* calling 'ifconfig DEV up' and enters it back on 'ifconfig DEV
|
||||
* down'.
|
||||
*
|
||||
* @__WIMAX_ST_QUIESCING: The device is being torn down, so no API
|
||||
* operations are allowed to proceed except the ones needed to
|
||||
* complete the device clean up process.
|
||||
*
|
||||
* @WIMAX_ST_UNINITIALIZED: [optional] Communication with the device
|
||||
* is setup, but the device still requires some configuration
|
||||
* before being operational.
|
||||
* Some WiMAX API calls might work.
|
||||
*
|
||||
* @WIMAX_ST_RADIO_OFF: The device is fully up; radio is off (wether
|
||||
* by hardware or software switches).
|
||||
* It is recommended to always leave the device in this state
|
||||
* after initialization.
|
||||
*
|
||||
* @WIMAX_ST_READY: The device is fully up and radio is on.
|
||||
*
|
||||
* @WIMAX_ST_SCANNING: [optional] The device has been instructed to
|
||||
* scan. In this state, the device cannot be actively connected to
|
||||
* a network.
|
||||
*
|
||||
* @WIMAX_ST_CONNECTING: The device is connecting to a network. This
|
||||
* state exists because in some devices, the connect process can
|
||||
* include a number of negotiations between user space, kernel
|
||||
* space and the device. User space needs to know what the device
|
||||
* is doing. If the connect sequence in a device is atomic and
|
||||
* fast, the device can transition directly to CONNECTED
|
||||
*
|
||||
* @WIMAX_ST_CONNECTED: The device is connected to a network.
|
||||
*
|
||||
* @__WIMAX_ST_INVALID: This is an invalid state used to mark the
|
||||
* maximum numeric value of states.
|
||||
*
|
||||
* Description:
|
||||
*
|
||||
* Transitions from one state to another one are atomic and can only
|
||||
* be caused in kernel space with wimax_state_change(). To read the
|
||||
* state, use wimax_state_get().
|
||||
*
|
||||
* States starting with __ are internal and shall not be used or
|
||||
* referred to by drivers or userspace. They look ugly, but that's the
|
||||
* point -- if any use is made non-internal to the stack, it is easier
|
||||
* to catch on review.
|
||||
*
|
||||
* All API operations [with well defined exceptions] will take the
|
||||
* device mutex before starting and then check the state. If the state
|
||||
* is %__WIMAX_ST_NULL, %WIMAX_ST_DOWN, %WIMAX_ST_UNINITIALIZED or
|
||||
* %__WIMAX_ST_QUIESCING, it will drop the lock and quit with
|
||||
* -%EINVAL, -%ENOMEDIUM, -%ENOTCONN or -%ESHUTDOWN.
|
||||
*
|
||||
* The order of the definitions is important, so we can do numerical
|
||||
* comparisons (eg: < %WIMAX_ST_RADIO_OFF means the device is not ready
|
||||
* to operate).
|
||||
*/
|
||||
/*
|
||||
* The allowed state transitions are described in the table below
|
||||
* (states in rows can go to states in columns where there is an X):
|
||||
*
|
||||
* UNINI RADIO READY SCAN CONNEC CONNEC
|
||||
* NULL DOWN QUIESCING TIALIZED OFF NING TING TED
|
||||
* NULL - x
|
||||
* DOWN - x x x
|
||||
* QUIESCING x -
|
||||
* UNINITIALIZED x - x
|
||||
* RADIO_OFF x - x
|
||||
* READY x x - x x x
|
||||
* SCANNING x x x - x x
|
||||
* CONNECTING x x x x - x
|
||||
* CONNECTED x x x -
|
||||
*
|
||||
* This table not available in kernel-doc because the formatting messes it up.
|
||||
*/
|
||||
enum wimax_st {
|
||||
__WIMAX_ST_NULL = 0,
|
||||
WIMAX_ST_DOWN,
|
||||
__WIMAX_ST_QUIESCING,
|
||||
WIMAX_ST_UNINITIALIZED,
|
||||
WIMAX_ST_RADIO_OFF,
|
||||
WIMAX_ST_READY,
|
||||
WIMAX_ST_SCANNING,
|
||||
WIMAX_ST_CONNECTING,
|
||||
WIMAX_ST_CONNECTED,
|
||||
__WIMAX_ST_INVALID /* Always keep last */
|
||||
};
|
||||
|
||||
|
||||
#endif /* #ifndef __LINUX__WIMAX_H__ */
|
||||
1
include/linux/wimax/Kbuild
Normal file
1
include/linux/wimax/Kbuild
Normal file
|
|
@ -0,0 +1 @@
|
|||
header-y += i2400m.h
|
||||
453
include/linux/wimax/debug.h
Normal file
453
include/linux/wimax/debug.h
Normal file
|
|
@ -0,0 +1,453 @@
|
|||
/*
|
||||
* Linux WiMAX
|
||||
* Collection of tools to manage debug operations.
|
||||
*
|
||||
*
|
||||
* Copyright (C) 2005-2007 Intel Corporation
|
||||
* Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
*
|
||||
* Don't #include this file directly, read on!
|
||||
*
|
||||
*
|
||||
* EXECUTING DEBUGGING ACTIONS OR NOT
|
||||
*
|
||||
* The main thing this framework provides is decission power to take a
|
||||
* debug action (like printing a message) if the current debug level
|
||||
* allows it.
|
||||
*
|
||||
* The decission power is at two levels: at compile-time (what does
|
||||
* not make it is compiled out) and at run-time. The run-time
|
||||
* selection is done per-submodule (as they are declared by the user
|
||||
* of the framework).
|
||||
*
|
||||
* A call to d_test(L) (L being the target debug level) returns true
|
||||
* if the action should be taken because the current debug levels
|
||||
* allow it (both compile and run time).
|
||||
*
|
||||
* It follows that a call to d_test() that can be determined to be
|
||||
* always false at compile time will get the code depending on it
|
||||
* compiled out by optimization.
|
||||
*
|
||||
*
|
||||
* DEBUG LEVELS
|
||||
*
|
||||
* It is up to the caller to define how much a debugging level is.
|
||||
*
|
||||
* Convention sets 0 as "no debug" (so an action marked as debug level 0
|
||||
* will always be taken). The increasing debug levels are used for
|
||||
* increased verbosity.
|
||||
*
|
||||
*
|
||||
* USAGE
|
||||
*
|
||||
* Group the code in modules and submodules inside each module [which
|
||||
* in most cases maps to Linux modules and .c files that compose
|
||||
* those].
|
||||
*
|
||||
*
|
||||
* For each module, there is:
|
||||
*
|
||||
* - a MODULENAME (single word, legal C identifier)
|
||||
*
|
||||
* - a debug-levels.h header file that declares the list of
|
||||
* submodules and that is included by all .c files that use
|
||||
* the debugging tools. The file name can be anything.
|
||||
*
|
||||
* - some (optional) .c code to manipulate the runtime debug levels
|
||||
* through debugfs.
|
||||
*
|
||||
* The debug-levels.h file would look like:
|
||||
*
|
||||
* #ifndef __debug_levels__h__
|
||||
* #define __debug_levels__h__
|
||||
*
|
||||
* #define D_MODULENAME modulename
|
||||
* #define D_MASTER 10
|
||||
*
|
||||
* #include <linux/wimax/debug.h>
|
||||
*
|
||||
* enum d_module {
|
||||
* D_SUBMODULE_DECLARE(submodule_1),
|
||||
* D_SUBMODULE_DECLARE(submodule_2),
|
||||
* ...
|
||||
* D_SUBMODULE_DECLARE(submodule_N)
|
||||
* };
|
||||
*
|
||||
* #endif
|
||||
*
|
||||
* D_MASTER is the maximum compile-time debug level; any debug actions
|
||||
* above this will be out. D_MODULENAME is the module name (legal C
|
||||
* identifier), which has to be unique for each module (to avoid
|
||||
* namespace collisions during linkage). Note those #defines need to
|
||||
* be done before #including debug.h
|
||||
*
|
||||
* We declare N different submodules whose debug level can be
|
||||
* independently controlled during runtime.
|
||||
*
|
||||
* In a .c file of the module (and only in one of them), define the
|
||||
* following code:
|
||||
*
|
||||
* struct d_level D_LEVEL[] = {
|
||||
* D_SUBMODULE_DEFINE(submodule_1),
|
||||
* D_SUBMODULE_DEFINE(submodule_2),
|
||||
* ...
|
||||
* D_SUBMODULE_DEFINE(submodule_N),
|
||||
* };
|
||||
* size_t D_LEVEL_SIZE = ARRAY_SIZE(D_LEVEL);
|
||||
*
|
||||
* Externs for d_level_MODULENAME and d_level_size_MODULENAME are used
|
||||
* and declared in this file using the D_LEVEL and D_LEVEL_SIZE macros
|
||||
* #defined also in this file.
|
||||
*
|
||||
* To manipulate from user space the levels, create a debugfs dentry
|
||||
* and then register each submodule with:
|
||||
*
|
||||
* result = d_level_register_debugfs("PREFIX_", submodule_X, parent);
|
||||
* if (result < 0)
|
||||
* goto error;
|
||||
*
|
||||
* Where PREFIX_ is a name of your chosing. This will create debugfs
|
||||
* file with a single numeric value that can be use to tweak it. To
|
||||
* remove the entires, just use debugfs_remove_recursive() on 'parent'.
|
||||
*
|
||||
* NOTE: remember that even if this will show attached to some
|
||||
* particular instance of a device, the settings are *global*.
|
||||
*
|
||||
*
|
||||
* On each submodule (for example, .c files), the debug infrastructure
|
||||
* should be included like this:
|
||||
*
|
||||
* #define D_SUBMODULE submodule_x // matches one in debug-levels.h
|
||||
* #include "debug-levels.h"
|
||||
*
|
||||
* after #including all your include files.
|
||||
*
|
||||
*
|
||||
* Now you can use the d_*() macros below [d_test(), d_fnstart(),
|
||||
* d_fnend(), d_printf(), d_dump()].
|
||||
*
|
||||
* If their debug level is greater than D_MASTER, they will be
|
||||
* compiled out.
|
||||
*
|
||||
* If their debug level is lower or equal than D_MASTER but greater
|
||||
* than the current debug level of their submodule, they'll be
|
||||
* ignored.
|
||||
*
|
||||
* Otherwise, the action will be performed.
|
||||
*/
|
||||
#ifndef __debug__h__
|
||||
#define __debug__h__
|
||||
|
||||
#include <linux/types.h>
|
||||
#include <linux/device.h>
|
||||
|
||||
|
||||
/* Backend stuff */
|
||||
|
||||
/*
|
||||
* Debug backend: generate a message header from a 'struct device'
|
||||
*
|
||||
* @head: buffer where to place the header
|
||||
* @head_size: length of @head
|
||||
* @dev: pointer to device used to generate a header from. If NULL,
|
||||
* an empty ("") header is generated.
|
||||
*/
|
||||
static inline
|
||||
void __d_head(char *head, size_t head_size,
|
||||
struct device *dev)
|
||||
{
|
||||
if (dev == NULL)
|
||||
head[0] = 0;
|
||||
else if ((unsigned long)dev < 4096) {
|
||||
printk(KERN_ERR "E: Corrupt dev %p\n", dev);
|
||||
WARN_ON(1);
|
||||
} else
|
||||
snprintf(head, head_size, "%s %s: ",
|
||||
dev_driver_string(dev), dev->bus_id);
|
||||
}
|
||||
|
||||
|
||||
/*
|
||||
* Debug backend: log some message if debugging is enabled
|
||||
*
|
||||
* @l: intended debug level
|
||||
* @tag: tag to prefix the message with
|
||||
* @dev: 'struct device' associated to this message
|
||||
* @f: printf-like format and arguments
|
||||
*
|
||||
* Note this is optimized out if it doesn't pass the compile-time
|
||||
* check; however, it is *always* compiled. This is useful to make
|
||||
* sure the printf-like formats and variables are always checked and
|
||||
* they don't get bit rot if you have all the debugging disabled.
|
||||
*/
|
||||
#define _d_printf(l, tag, dev, f, a...) \
|
||||
do { \
|
||||
char head[64]; \
|
||||
if (!d_test(l)) \
|
||||
break; \
|
||||
__d_head(head, sizeof(head), dev); \
|
||||
printk(KERN_ERR "%s%s%s: " f, head, __func__, tag, ##a); \
|
||||
} while (0)
|
||||
|
||||
|
||||
/*
|
||||
* CPP sintatic sugar to generate A_B like symbol names when one of
|
||||
* the arguments is a a preprocessor #define.
|
||||
*/
|
||||
#define __D_PASTE__(varname, modulename) varname##_##modulename
|
||||
#define __D_PASTE(varname, modulename) (__D_PASTE__(varname, modulename))
|
||||
#define _D_SUBMODULE_INDEX(_name) (D_SUBMODULE_DECLARE(_name))
|
||||
|
||||
|
||||
/*
|
||||
* Store a submodule's runtime debug level and name
|
||||
*/
|
||||
struct d_level {
|
||||
u8 level;
|
||||
const char *name;
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* List of available submodules and their debug levels
|
||||
*
|
||||
* We call them d_level_MODULENAME and d_level_size_MODULENAME; the
|
||||
* macros D_LEVEL and D_LEVEL_SIZE contain the name already for
|
||||
* convenience.
|
||||
*
|
||||
* This array and the size are defined on some .c file that is part of
|
||||
* the current module.
|
||||
*/
|
||||
#define D_LEVEL __D_PASTE(d_level, D_MODULENAME)
|
||||
#define D_LEVEL_SIZE __D_PASTE(d_level_size, D_MODULENAME)
|
||||
|
||||
extern struct d_level D_LEVEL[];
|
||||
extern size_t D_LEVEL_SIZE;
|
||||
|
||||
|
||||
/*
|
||||
* Frontend stuff
|
||||
*
|
||||
*
|
||||
* Stuff you need to declare prior to using the actual "debug" actions
|
||||
* (defined below).
|
||||
*/
|
||||
|
||||
#ifndef D_MODULENAME
|
||||
#error D_MODULENAME is not defined in your debug-levels.h file
|
||||
/**
|
||||
* D_MODULE - Name of the current module
|
||||
*
|
||||
* #define in your module's debug-levels.h, making sure it is
|
||||
* unique. This has to be a legal C identifier.
|
||||
*/
|
||||
#define D_MODULENAME undefined_modulename
|
||||
#endif
|
||||
|
||||
|
||||
#ifndef D_MASTER
|
||||
#warning D_MASTER not defined, but debug.h included! [see docs]
|
||||
/**
|
||||
* D_MASTER - Compile time maximum debug level
|
||||
*
|
||||
* #define in your debug-levels.h file to the maximum debug level the
|
||||
* runtime code will be allowed to have. This allows you to provide a
|
||||
* main knob.
|
||||
*
|
||||
* Anything above that level will be optimized out of the compile.
|
||||
*
|
||||
* Defaults to zero (no debug code compiled in).
|
||||
*
|
||||
* Maximum one definition per module (at the debug-levels.h file).
|
||||
*/
|
||||
#define D_MASTER 0
|
||||
#endif
|
||||
|
||||
#ifndef D_SUBMODULE
|
||||
#error D_SUBMODULE not defined, but debug.h included! [see docs]
|
||||
/**
|
||||
* D_SUBMODULE - Name of the current submodule
|
||||
*
|
||||
* #define in your submodule .c file before #including debug-levels.h
|
||||
* to the name of the current submodule as previously declared and
|
||||
* defined with D_SUBMODULE_DECLARE() (in your module's
|
||||
* debug-levels.h) and D_SUBMODULE_DEFINE().
|
||||
*
|
||||
* This is used to provide runtime-control over the debug levels.
|
||||
*
|
||||
* Maximum one per .c file! Can be shared among different .c files
|
||||
* (meaning they belong to the same submodule categorization).
|
||||
*/
|
||||
#define D_SUBMODULE undefined_module
|
||||
#endif
|
||||
|
||||
|
||||
/**
|
||||
* D_SUBMODULE_DECLARE - Declare a submodule for runtime debug level control
|
||||
*
|
||||
* @_name: name of the submodule, restricted to the chars that make up a
|
||||
* valid C identifier ([a-zA-Z0-9_]).
|
||||
*
|
||||
* Declare in the module's debug-levels.h header file as:
|
||||
*
|
||||
* enum d_module {
|
||||
* D_SUBMODULE_DECLARE(submodule_1),
|
||||
* D_SUBMODULE_DECLARE(submodule_2),
|
||||
* D_SUBMODULE_DECLARE(submodule_3),
|
||||
* };
|
||||
*
|
||||
* Some corresponding .c file needs to have a matching
|
||||
* D_SUBMODULE_DEFINE().
|
||||
*/
|
||||
#define D_SUBMODULE_DECLARE(_name) __D_SUBMODULE_##_name
|
||||
|
||||
|
||||
/**
|
||||
* D_SUBMODULE_DEFINE - Define a submodule for runtime debug level control
|
||||
*
|
||||
* @_name: name of the submodule, restricted to the chars that make up a
|
||||
* valid C identifier ([a-zA-Z0-9_]).
|
||||
*
|
||||
* Use once per module (in some .c file) as:
|
||||
*
|
||||
* static
|
||||
* struct d_level d_level_SUBMODULENAME[] = {
|
||||
* D_SUBMODULE_DEFINE(submodule_1),
|
||||
* D_SUBMODULE_DEFINE(submodule_2),
|
||||
* D_SUBMODULE_DEFINE(submodule_3),
|
||||
* };
|
||||
* size_t d_level_size_SUBDMODULENAME = ARRAY_SIZE(d_level_SUBDMODULENAME);
|
||||
*
|
||||
* Matching D_SUBMODULE_DECLARE()s have to be present in a
|
||||
* debug-levels.h header file.
|
||||
*/
|
||||
#define D_SUBMODULE_DEFINE(_name) \
|
||||
[__D_SUBMODULE_##_name] = { \
|
||||
.level = 0, \
|
||||
.name = #_name \
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* The actual "debug" operations */
|
||||
|
||||
|
||||
/**
|
||||
* d_test - Returns true if debugging should be enabled
|
||||
*
|
||||
* @l: intended debug level (unsigned)
|
||||
*
|
||||
* If the master debug switch is enabled and the current settings are
|
||||
* higher or equal to the requested level, then debugging
|
||||
* output/actions should be enabled.
|
||||
*
|
||||
* NOTE:
|
||||
*
|
||||
* This needs to be coded so that it can be evaluated in compile
|
||||
* time; this is why the ugly BUG_ON() is placed in there, so the
|
||||
* D_MASTER evaluation compiles all out if it is compile-time false.
|
||||
*/
|
||||
#define d_test(l) \
|
||||
({ \
|
||||
unsigned __l = l; /* type enforcer */ \
|
||||
(D_MASTER) >= __l \
|
||||
&& ({ \
|
||||
BUG_ON(_D_SUBMODULE_INDEX(D_SUBMODULE) >= D_LEVEL_SIZE);\
|
||||
D_LEVEL[_D_SUBMODULE_INDEX(D_SUBMODULE)].level >= __l; \
|
||||
}); \
|
||||
})
|
||||
|
||||
|
||||
/**
|
||||
* d_fnstart - log message at function start if debugging enabled
|
||||
*
|
||||
* @l: intended debug level
|
||||
* @_dev: 'struct device' pointer, NULL if none (for context)
|
||||
* @f: printf-like format and arguments
|
||||
*/
|
||||
#define d_fnstart(l, _dev, f, a...) _d_printf(l, " FNSTART", _dev, f, ## a)
|
||||
|
||||
|
||||
/**
|
||||
* d_fnend - log message at function end if debugging enabled
|
||||
*
|
||||
* @l: intended debug level
|
||||
* @_dev: 'struct device' pointer, NULL if none (for context)
|
||||
* @f: printf-like format and arguments
|
||||
*/
|
||||
#define d_fnend(l, _dev, f, a...) _d_printf(l, " FNEND", _dev, f, ## a)
|
||||
|
||||
|
||||
/**
|
||||
* d_printf - log message if debugging enabled
|
||||
*
|
||||
* @l: intended debug level
|
||||
* @_dev: 'struct device' pointer, NULL if none (for context)
|
||||
* @f: printf-like format and arguments
|
||||
*/
|
||||
#define d_printf(l, _dev, f, a...) _d_printf(l, "", _dev, f, ## a)
|
||||
|
||||
|
||||
/**
|
||||
* d_dump - log buffer hex dump if debugging enabled
|
||||
*
|
||||
* @l: intended debug level
|
||||
* @_dev: 'struct device' pointer, NULL if none (for context)
|
||||
* @f: printf-like format and arguments
|
||||
*/
|
||||
#define d_dump(l, dev, ptr, size) \
|
||||
do { \
|
||||
char head[64]; \
|
||||
if (!d_test(l)) \
|
||||
break; \
|
||||
__d_head(head, sizeof(head), dev); \
|
||||
print_hex_dump(KERN_ERR, head, 0, 16, 1, \
|
||||
((void *) ptr), (size), 0); \
|
||||
} while (0)
|
||||
|
||||
|
||||
/**
|
||||
* Export a submodule's debug level over debugfs as PREFIXSUBMODULE
|
||||
*
|
||||
* @prefix: string to prefix the name with
|
||||
* @submodule: name of submodule (not a string, just the name)
|
||||
* @dentry: debugfs parent dentry
|
||||
*
|
||||
* Returns: 0 if ok, < 0 errno on error.
|
||||
*
|
||||
* For removing, just use debugfs_remove_recursive() on the parent.
|
||||
*/
|
||||
#define d_level_register_debugfs(prefix, name, parent) \
|
||||
({ \
|
||||
int rc; \
|
||||
struct dentry *fd; \
|
||||
struct dentry *verify_parent_type = parent; \
|
||||
fd = debugfs_create_u8( \
|
||||
prefix #name, 0600, verify_parent_type, \
|
||||
&(D_LEVEL[__D_SUBMODULE_ ## name].level)); \
|
||||
rc = PTR_ERR(fd); \
|
||||
if (IS_ERR(fd) && rc != -ENODEV) \
|
||||
printk(KERN_ERR "%s: Can't create debugfs entry %s: " \
|
||||
"%d\n", __func__, prefix #name, rc); \
|
||||
else \
|
||||
rc = 0; \
|
||||
rc; \
|
||||
})
|
||||
|
||||
|
||||
#endif /* #ifndef __debug__h__ */
|
||||
512
include/linux/wimax/i2400m.h
Normal file
512
include/linux/wimax/i2400m.h
Normal file
|
|
@ -0,0 +1,512 @@
|
|||
/*
|
||||
* Intel Wireless WiMax Connection 2400m
|
||||
* Host-Device protocol interface definitions
|
||||
*
|
||||
*
|
||||
* Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* * Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* * Neither the name of Intel Corporation nor the names of its
|
||||
* contributors may be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*
|
||||
* Intel Corporation <linux-wimax@intel.com>
|
||||
* Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
|
||||
* - Initial implementation
|
||||
*
|
||||
*
|
||||
* This header defines the data structures and constants used to
|
||||
* communicate with the device.
|
||||
*
|
||||
* BOOTMODE/BOOTROM/FIRMWARE UPLOAD PROTOCOL
|
||||
*
|
||||
* The firmware upload protocol is quite simple and only requires a
|
||||
* handful of commands. See drivers/net/wimax/i2400m/fw.c for more
|
||||
* details.
|
||||
*
|
||||
* The BCF data structure is for the firmware file header.
|
||||
*
|
||||
*
|
||||
* THE DATA / CONTROL PROTOCOL
|
||||
*
|
||||
* This is the normal protocol spoken with the device once the
|
||||
* firmware is uploaded. It transports data payloads and control
|
||||
* messages back and forth.
|
||||
*
|
||||
* It consists 'messages' that pack one or more payloads each. The
|
||||
* format is described in detail in drivers/net/wimax/i2400m/rx.c and
|
||||
* tx.c.
|
||||
*
|
||||
*
|
||||
* THE L3L4 PROTOCOL
|
||||
*
|
||||
* The term L3L4 refers to Layer 3 (the device), Layer 4 (the
|
||||
* driver/host software).
|
||||
*
|
||||
* This is the control protocol used by the host to control the i2400m
|
||||
* device (scan, connect, disconnect...). This is sent to / received
|
||||
* as control frames. These frames consist of a header and zero or
|
||||
* more TLVs with information. We call each control frame a "message".
|
||||
*
|
||||
* Each message is composed of:
|
||||
*
|
||||
* HEADER
|
||||
* [TLV0 + PAYLOAD0]
|
||||
* [TLV1 + PAYLOAD1]
|
||||
* [...]
|
||||
* [TLVN + PAYLOADN]
|
||||
*
|
||||
* The HEADER is defined by 'struct i2400m_l3l4_hdr'. The payloads are
|
||||
* defined by a TLV structure (Type Length Value) which is a 'header'
|
||||
* (struct i2400m_tlv_hdr) and then the payload.
|
||||
*
|
||||
* All integers are represented as Little Endian.
|
||||
*
|
||||
* - REQUESTS AND EVENTS
|
||||
*
|
||||
* The requests can be clasified as follows:
|
||||
*
|
||||
* COMMAND: implies a request from the host to the device requesting
|
||||
* an action being performed. The device will reply with a
|
||||
* message (with the same type as the command), status and
|
||||
* no (TLV) payload. Execution of a command might cause
|
||||
* events (of different type) to be sent later on as
|
||||
* device's state changes.
|
||||
*
|
||||
* GET/SET: similar to COMMAND, but will not cause other
|
||||
* EVENTs. The reply, in the case of GET, will contain
|
||||
* TLVs with the requested information.
|
||||
*
|
||||
* EVENT: asynchronous messages sent from the device, maybe as a
|
||||
* consequence of previous COMMANDs but disassociated from
|
||||
* them.
|
||||
*
|
||||
* Only one request might be pending at the same time (ie: don't
|
||||
* parallelize nor post another GET request before the previous
|
||||
* COMMAND has been acknowledged with it's corresponding reply by the
|
||||
* device).
|
||||
*
|
||||
* The different requests and their formats are described below:
|
||||
*
|
||||
* I2400M_MT_* Message types
|
||||
* I2400M_MS_* Message status (for replies, events)
|
||||
* i2400m_tlv_* TLVs
|
||||
*
|
||||
* data types are named 'struct i2400m_msg_OPNAME', OPNAME matching the
|
||||
* operation.
|
||||
*/
|
||||
|
||||
#ifndef __LINUX__WIMAX__I2400M_H__
|
||||
#define __LINUX__WIMAX__I2400M_H__
|
||||
|
||||
#include <linux/types.h>
|
||||
|
||||
|
||||
/*
|
||||
* Host Device Interface (HDI) common to all busses
|
||||
*/
|
||||
|
||||
/* Boot-mode (firmware upload mode) commands */
|
||||
|
||||
/* Header for the firmware file */
|
||||
struct i2400m_bcf_hdr {
|
||||
__le32 module_type;
|
||||
__le32 header_len;
|
||||
__le32 header_version;
|
||||
__le32 module_id;
|
||||
__le32 module_vendor;
|
||||
__le32 date; /* BCD YYYMMDD */
|
||||
__le32 size;
|
||||
__le32 key_size; /* in dwords */
|
||||
__le32 modulus_size; /* in dwords */
|
||||
__le32 exponent_size; /* in dwords */
|
||||
__u8 reserved[88];
|
||||
} __attribute__ ((packed));
|
||||
|
||||
/* Boot mode opcodes */
|
||||
enum i2400m_brh_opcode {
|
||||
I2400M_BRH_READ = 1,
|
||||
I2400M_BRH_WRITE = 2,
|
||||
I2400M_BRH_JUMP = 3,
|
||||
I2400M_BRH_SIGNED_JUMP = 8,
|
||||
I2400M_BRH_HASH_PAYLOAD_ONLY = 9,
|
||||
};
|
||||
|
||||
/* Boot mode command masks and stuff */
|
||||
enum i2400m_brh {
|
||||
I2400M_BRH_SIGNATURE = 0xcbbc0000,
|
||||
I2400M_BRH_SIGNATURE_MASK = 0xffff0000,
|
||||
I2400M_BRH_SIGNATURE_SHIFT = 16,
|
||||
I2400M_BRH_OPCODE_MASK = 0x0000000f,
|
||||
I2400M_BRH_RESPONSE_MASK = 0x000000f0,
|
||||
I2400M_BRH_RESPONSE_SHIFT = 4,
|
||||
I2400M_BRH_DIRECT_ACCESS = 0x00000400,
|
||||
I2400M_BRH_RESPONSE_REQUIRED = 0x00000200,
|
||||
I2400M_BRH_USE_CHECKSUM = 0x00000100,
|
||||
};
|
||||
|
||||
|
||||
/* Constants for bcf->module_id */
|
||||
enum i2400m_bcf_mod_id {
|
||||
/* Firmware file carries its own pokes -- pokes are a set of
|
||||
* magical values that have to be written in certain memory
|
||||
* addresses to get the device up and ready for firmware
|
||||
* download when it is in non-signed boot mode. */
|
||||
I2400M_BCF_MOD_ID_POKES = 0x000000001,
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* i2400m_bootrom_header - Header for a boot-mode command
|
||||
*
|
||||
* @cmd: the above command descriptor
|
||||
* @target_addr: where on the device memory should the action be performed.
|
||||
* @data_size: for read/write, amount of data to be read/written
|
||||
* @block_checksum: checksum value (if applicable)
|
||||
* @payload: the beginning of data attached to this header
|
||||
*/
|
||||
struct i2400m_bootrom_header {
|
||||
__le32 command; /* Compose with enum i2400_brh */
|
||||
__le32 target_addr;
|
||||
__le32 data_size;
|
||||
__le32 block_checksum;
|
||||
char payload[0];
|
||||
} __attribute__ ((packed));
|
||||
|
||||
|
||||
/*
|
||||
* Data / control protocol
|
||||
*/
|
||||
|
||||
/* Packet types for the host-device interface */
|
||||
enum i2400m_pt {
|
||||
I2400M_PT_DATA = 0,
|
||||
I2400M_PT_CTRL,
|
||||
I2400M_PT_TRACE, /* For device debug */
|
||||
I2400M_PT_RESET_WARM, /* device reset */
|
||||
I2400M_PT_RESET_COLD, /* USB[transport] reset, like reconnect */
|
||||
I2400M_PT_ILLEGAL
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* Payload for a data packet
|
||||
*
|
||||
* This is prefixed to each and every outgoing DATA type.
|
||||
*/
|
||||
struct i2400m_pl_data_hdr {
|
||||
__le32 reserved;
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
/* Misc constants */
|
||||
enum {
|
||||
I2400M_PL_PAD = 16, /* Payload data size alignment */
|
||||
I2400M_PL_SIZE_MAX = 0x3EFF,
|
||||
I2400M_MAX_PLS_IN_MSG = 60,
|
||||
/* protocol barkers: sync sequences; for notifications they
|
||||
* are sent in groups of four. */
|
||||
I2400M_H2D_PREVIEW_BARKER = 0xcafe900d,
|
||||
I2400M_COLD_RESET_BARKER = 0xc01dc01d,
|
||||
I2400M_WARM_RESET_BARKER = 0x50f750f7,
|
||||
I2400M_NBOOT_BARKER = 0xdeadbeef,
|
||||
I2400M_SBOOT_BARKER = 0x0ff1c1a1,
|
||||
I2400M_ACK_BARKER = 0xfeedbabe,
|
||||
I2400M_D2H_MSG_BARKER = 0xbeefbabe,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* Hardware payload descriptor
|
||||
*
|
||||
* Bitfields encoded in a struct to enforce typing semantics.
|
||||
*
|
||||
* Look in rx.c and tx.c for a full description of the format.
|
||||
*/
|
||||
struct i2400m_pld {
|
||||
__le32 val;
|
||||
} __attribute__ ((packed));
|
||||
|
||||
#define I2400M_PLD_SIZE_MASK 0x00003fff
|
||||
#define I2400M_PLD_TYPE_SHIFT 16
|
||||
#define I2400M_PLD_TYPE_MASK 0x000f0000
|
||||
|
||||
/*
|
||||
* Header for a TX message or RX message
|
||||
*
|
||||
* @barker: preamble
|
||||
* @size: used for management of the FIFO queue buffer; before
|
||||
* sending, this is converted to be a real preamble. This
|
||||
* indicates the real size of the TX message that starts at this
|
||||
* point. If the highest bit is set, then this message is to be
|
||||
* skipped.
|
||||
* @sequence: sequence number of this message
|
||||
* @offset: offset where the message itself starts -- see the comments
|
||||
* in the file header about message header and payload descriptor
|
||||
* alignment.
|
||||
* @num_pls: number of payloads in this message
|
||||
* @padding: amount of padding bytes at the end of the message to make
|
||||
* it be of block-size aligned
|
||||
*
|
||||
* Look in rx.c and tx.c for a full description of the format.
|
||||
*/
|
||||
struct i2400m_msg_hdr {
|
||||
union {
|
||||
__le32 barker;
|
||||
__u32 size; /* same size type as barker!! */
|
||||
};
|
||||
union {
|
||||
__le32 sequence;
|
||||
__u32 offset; /* same size type as barker!! */
|
||||
};
|
||||
__le16 num_pls;
|
||||
__le16 rsv1;
|
||||
__le16 padding;
|
||||
__le16 rsv2;
|
||||
struct i2400m_pld pld[0];
|
||||
} __attribute__ ((packed));
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* L3/L4 control protocol
|
||||
*/
|
||||
|
||||
enum {
|
||||
/* Interface version */
|
||||
I2400M_L3L4_VERSION = 0x0100,
|
||||
};
|
||||
|
||||
/* Message types */
|
||||
enum i2400m_mt {
|
||||
I2400M_MT_RESERVED = 0x0000,
|
||||
I2400M_MT_INVALID = 0xffff,
|
||||
I2400M_MT_REPORT_MASK = 0x8000,
|
||||
|
||||
I2400M_MT_GET_SCAN_RESULT = 0x4202,
|
||||
I2400M_MT_SET_SCAN_PARAM = 0x4402,
|
||||
I2400M_MT_CMD_RF_CONTROL = 0x4602,
|
||||
I2400M_MT_CMD_SCAN = 0x4603,
|
||||
I2400M_MT_CMD_CONNECT = 0x4604,
|
||||
I2400M_MT_CMD_DISCONNECT = 0x4605,
|
||||
I2400M_MT_CMD_EXIT_IDLE = 0x4606,
|
||||
I2400M_MT_GET_LM_VERSION = 0x5201,
|
||||
I2400M_MT_GET_DEVICE_INFO = 0x5202,
|
||||
I2400M_MT_GET_LINK_STATUS = 0x5203,
|
||||
I2400M_MT_GET_STATISTICS = 0x5204,
|
||||
I2400M_MT_GET_STATE = 0x5205,
|
||||
I2400M_MT_GET_MEDIA_STATUS = 0x5206,
|
||||
I2400M_MT_SET_INIT_CONFIG = 0x5404,
|
||||
I2400M_MT_CMD_INIT = 0x5601,
|
||||
I2400M_MT_CMD_TERMINATE = 0x5602,
|
||||
I2400M_MT_CMD_MODE_OF_OP = 0x5603,
|
||||
I2400M_MT_CMD_RESET_DEVICE = 0x5604,
|
||||
I2400M_MT_CMD_MONITOR_CONTROL = 0x5605,
|
||||
I2400M_MT_CMD_ENTER_POWERSAVE = 0x5606,
|
||||
I2400M_MT_GET_TLS_OPERATION_RESULT = 0x6201,
|
||||
I2400M_MT_SET_EAP_SUCCESS = 0x6402,
|
||||
I2400M_MT_SET_EAP_FAIL = 0x6403,
|
||||
I2400M_MT_SET_EAP_KEY = 0x6404,
|
||||
I2400M_MT_CMD_SEND_EAP_RESPONSE = 0x6602,
|
||||
I2400M_MT_REPORT_SCAN_RESULT = 0xc002,
|
||||
I2400M_MT_REPORT_STATE = 0xd002,
|
||||
I2400M_MT_REPORT_POWERSAVE_READY = 0xd005,
|
||||
I2400M_MT_REPORT_EAP_REQUEST = 0xe002,
|
||||
I2400M_MT_REPORT_EAP_RESTART = 0xe003,
|
||||
I2400M_MT_REPORT_ALT_ACCEPT = 0xe004,
|
||||
I2400M_MT_REPORT_KEY_REQUEST = 0xe005,
|
||||
};
|
||||
|
||||
|
||||
/*
|
||||
* Message Ack Status codes
|
||||
*
|
||||
* When a message is replied-to, this status is reported.
|
||||
*/
|
||||
enum i2400m_ms {
|
||||
I2400M_MS_DONE_OK = 0,
|
||||
I2400M_MS_DONE_IN_PROGRESS = 1,
|
||||
I2400M_MS_INVALID_OP = 2,
|
||||
I2400M_MS_BAD_STATE = 3,
|
||||
I2400M_MS_ILLEGAL_VALUE = 4,
|
||||
I2400M_MS_MISSING_PARAMS = 5,
|
||||
I2400M_MS_VERSION_ERROR = 6,
|
||||
I2400M_MS_ACCESSIBILITY_ERROR = 7,
|
||||
I2400M_MS_BUSY = 8,
|
||||
I2400M_MS_CORRUPTED_TLV = 9,
|
||||
I2400M_MS_UNINITIALIZED = 10,
|
||||
I2400M_MS_UNKNOWN_ERROR = 11,
|
||||
I2400M_MS_PRODUCTION_ERROR = 12,
|
||||
I2400M_MS_NO_RF = 13,
|
||||
I2400M_MS_NOT_READY_FOR_POWERSAVE = 14,
|
||||
I2400M_MS_THERMAL_CRITICAL = 15,
|
||||
I2400M_MS_MAX
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* i2400m_tlv - enumeration of the different types of TLVs
|
||||
*
|
||||
* TLVs stand for type-length-value and are the header for a payload
|
||||
* composed of almost anything. Each payload has a type assigned
|
||||
* and a length.
|
||||
*/
|
||||
enum i2400m_tlv {
|
||||
I2400M_TLV_L4_MESSAGE_VERSIONS = 129,
|
||||
I2400M_TLV_SYSTEM_STATE = 141,
|
||||
I2400M_TLV_MEDIA_STATUS = 161,
|
||||
I2400M_TLV_RF_OPERATION = 162,
|
||||
I2400M_TLV_RF_STATUS = 163,
|
||||
I2400M_TLV_DEVICE_RESET_TYPE = 132,
|
||||
I2400M_TLV_CONFIG_IDLE_PARAMETERS = 601,
|
||||
};
|
||||
|
||||
|
||||
struct i2400m_tlv_hdr {
|
||||
__le16 type;
|
||||
__le16 length; /* payload's */
|
||||
__u8 pl[0];
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
struct i2400m_l3l4_hdr {
|
||||
__le16 type;
|
||||
__le16 length; /* payload's */
|
||||
__le16 version;
|
||||
__le16 resv1;
|
||||
__le16 status;
|
||||
__le16 resv2;
|
||||
struct i2400m_tlv_hdr pl[0];
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
/**
|
||||
* i2400m_system_state - different states of the device
|
||||
*/
|
||||
enum i2400m_system_state {
|
||||
I2400M_SS_UNINITIALIZED = 1,
|
||||
I2400M_SS_INIT,
|
||||
I2400M_SS_READY,
|
||||
I2400M_SS_SCAN,
|
||||
I2400M_SS_STANDBY,
|
||||
I2400M_SS_CONNECTING,
|
||||
I2400M_SS_WIMAX_CONNECTED,
|
||||
I2400M_SS_DATA_PATH_CONNECTED,
|
||||
I2400M_SS_IDLE,
|
||||
I2400M_SS_DISCONNECTING,
|
||||
I2400M_SS_OUT_OF_ZONE,
|
||||
I2400M_SS_SLEEPACTIVE,
|
||||
I2400M_SS_PRODUCTION,
|
||||
I2400M_SS_CONFIG,
|
||||
I2400M_SS_RF_OFF,
|
||||
I2400M_SS_RF_SHUTDOWN,
|
||||
I2400M_SS_DEVICE_DISCONNECT,
|
||||
I2400M_SS_MAX,
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
* i2400m_tlv_system_state - report on the state of the system
|
||||
*
|
||||
* @state: see enum i2400m_system_state
|
||||
*/
|
||||
struct i2400m_tlv_system_state {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__le32 state;
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
struct i2400m_tlv_l4_message_versions {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__le16 major;
|
||||
__le16 minor;
|
||||
__le16 branch;
|
||||
__le16 reserved;
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
struct i2400m_tlv_detailed_device_info {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__u8 reserved1[400];
|
||||
__u8 mac_address[6];
|
||||
__u8 reserved2[2];
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
enum i2400m_rf_switch_status {
|
||||
I2400M_RF_SWITCH_ON = 1,
|
||||
I2400M_RF_SWITCH_OFF = 2,
|
||||
};
|
||||
|
||||
struct i2400m_tlv_rf_switches_status {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__u8 sw_rf_switch; /* 1 ON, 2 OFF */
|
||||
__u8 hw_rf_switch; /* 1 ON, 2 OFF */
|
||||
__u8 reserved[2];
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
enum {
|
||||
i2400m_rf_operation_on = 1,
|
||||
i2400m_rf_operation_off = 2
|
||||
};
|
||||
|
||||
struct i2400m_tlv_rf_operation {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__le32 status; /* 1 ON, 2 OFF */
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
enum i2400m_tlv_reset_type {
|
||||
I2400M_RESET_TYPE_COLD = 1,
|
||||
I2400M_RESET_TYPE_WARM
|
||||
};
|
||||
|
||||
struct i2400m_tlv_device_reset_type {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__le32 reset_type;
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
struct i2400m_tlv_config_idle_parameters {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__le32 idle_timeout; /* 100 to 300000 ms [5min], 100 increments
|
||||
* 0 disabled */
|
||||
__le32 idle_paging_interval; /* frames */
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
enum i2400m_media_status {
|
||||
I2400M_MEDIA_STATUS_LINK_UP = 1,
|
||||
I2400M_MEDIA_STATUS_LINK_DOWN,
|
||||
I2400M_MEDIA_STATUS_LINK_RENEW,
|
||||
};
|
||||
|
||||
struct i2400m_tlv_media_status {
|
||||
struct i2400m_tlv_hdr hdr;
|
||||
__le32 media_status;
|
||||
} __attribute__((packed));
|
||||
|
||||
#endif /* #ifndef __LINUX__WIMAX__I2400M_H__ */
|
||||
Loading…
Add table
Add a link
Reference in a new issue