ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / linux

/*
 * 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 = 01,
	/* 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 */
	WIMAX_GNL_OP_STATE_GET,		/* Request for current state */
};

/* 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 wimax_state_get() */
enum {
	WIMAX_GNL_STGET_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__ */

[+] ..
[-] sysinfo.h [edit]
[-] mroute.h [edit]
[-] if_eql.h [edit]
[-] serial_core.h [edit]
[-] membarrier.h [edit]
[-] sched.h [edit]
[-] mei.h [edit]
[-] bfs_fs.h [edit]
[-] atmlec.h [edit]
[-] v4l2-mediabus.h [edit]
[-] videodev2.h [edit]
[-] screen_info.h [edit]
[-] if_slip.h [edit]
[-] uuid.h [edit]
[-] version.h [edit]
[-] ipv6_route.h [edit]
[-] ixjuser.h [edit]
[-] pkt_cls.h [edit]
[-] atm_he.h [edit]
[-] raw.h [edit]
[-] msdos_fs.h [edit]
[-] mman.h [edit]
[-] aio_abi.h [edit]
[-] reboot.h [edit]
[-] snmp.h [edit]
[-] atm_eni.h [edit]
[-] netfilter_bridge.h [edit]
[-] patchkey.h [edit]
[-] string.h [edit]
[-] socket.h [edit]
[+] spi
[-] auxvec.h [edit]
[-] sockios.h [edit]
[-] keyboard.h [edit]
[-] scc.h [edit]
[-] dn.h [edit]
[-] unistd.h [edit]
[-] oom.h [edit]
[-] pkt_sched.h [edit]
[-] if_phonet.h [edit]
[+] byteorder
[-] if_arcnet.h [edit]
[+] caif
[-] fd.h [edit]
[-] radeonfb.h [edit]
[-] qnx4_fs.h [edit]
[-] nfs2.h [edit]
[-] magic.h [edit]
[-] target_core_user.h [edit]
[-] atm_zatm.h [edit]
[-] pci.h [edit]
[-] nfsacl.h [edit]
[-] if_packet.h [edit]
[-] arcfb.h [edit]
[-] nfs_mount.h [edit]
[-] fib_rules.h [edit]
[-] atmsap.h [edit]
[+] dvb
[-] cciss_defs.h [edit]
[+] netfilter_ipv6
[-] atmdev.h [edit]
[-] kexec.h [edit]
[-] ipc.h [edit]
[-] sock_diag.h [edit]
[+] wimax
[-] serial.h [edit]
[-] if_link.h [edit]
[-] route.h [edit]
[-] if_bonding.h [edit]
[-] auto_fs.h [edit]
[-] pg.h [edit]
[-] l2tp.h [edit]
[-] perf_event.h [edit]
[-] tcp_metrics.h [edit]
[-] v4l2-controls.h [edit]
[-] personality.h [edit]
[-] dcbnl.h [edit]
[-] netfilter_arp.h [edit]
[-] toshiba.h [edit]
[-] memfd.h [edit]
[-] resource.h [edit]
[-] tipc.h [edit]
[-] virtio_vsock.h [edit]
[-] atm_tcp.h [edit]
[-] cn_proc.h [edit]
[-] utime.h [edit]
[-] nbd.h [edit]
[-] netfilter_ipv6.h [edit]
[-] meye.h [edit]
[-] gfs2_ondisk.h [edit]
[-] som.h [edit]
[-] ncp_mount.h [edit]
[-] coda.h [edit]
[-] hw_breakpoint.h [edit]
[-] shm.h [edit]
[-] wanrouter.h [edit]
[-] kernel-page-flags.h [edit]
[-] auto_fs4.h [edit]
[-] ppp_defs.h [edit]
[-] tty.h [edit]
[-] sysctl.h [edit]
[-] joystick.h [edit]
[-] ip.h [edit]
[-] jffs2.h [edit]
[-] nfs3.h [edit]
[-] if_infiniband.h [edit]
[-] agpgart.h [edit]
[+] raid
[-] blkpg.h [edit]
[-] virtio_ids.h [edit]
[-] udp.h [edit]
[-] swab.h [edit]
[-] romfs_fs.h [edit]
[-] fb.h [edit]
[-] kvm_para.h [edit]
[-] btrfs.h [edit]
[-] efs_fs_sb.h [edit]
[-] xfrm.h [edit]
[-] iso_fs.h [edit]
[-] serial_reg.h [edit]
[-] virtio_gpu.h [edit]
[-] sound.h [edit]
[-] errno.h [edit]
[-] kernelcapi.h [edit]
[-] net_tstamp.h [edit]
[-] isdnif.h [edit]
[-] hiddev.h [edit]
[-] ncp_fs.h [edit]
[-] hdlc.h [edit]
[-] fcntl.h [edit]
[-] if.h [edit]
[-] minix_fs.h [edit]
[-] hdreg.h [edit]
[-] virtio_9p.h [edit]
[-] coff.h [edit]
[-] elf-em.h [edit]
[-] mqueue.h [edit]
[+] tc_ematch
[-] gameport.h [edit]
[-] if_ether.h [edit]
[-] if_addrlabel.h [edit]
[-] ife.h [edit]
[-] isdn_divertif.h [edit]
[-] rds.h [edit]
[-] fdreg.h [edit]
[-] pmu.h [edit]
[-] cuda.h [edit]
[-] stat.h [edit]
[-] virtio_net.h [edit]
[-] posix_types.h [edit]
[-] cyclades.h [edit]
[-] baycom.h [edit]
[-] ipv6.h [edit]
[-] net_dropmon.h [edit]
[-] ipmi_msgdefs.h [edit]
[+] netfilter_arp
[-] v4l2-subdev.h [edit]
[-] vsockmon.h [edit]
[-] neighbour.h [edit]
[-] sctp.h [edit]
[-] atmppp.h [edit]
[-] usbdevice_fs.h [edit]
[-] dm-ioctl.h [edit]
[-] netconf.h [edit]
[-] v4l2-dv-timings.h [edit]
[-] chio.h [edit]
[-] msg.h [edit]
[+] netfilter_ipv4
[-] netlink.h [edit]
[-] genetlink.h [edit]
[-] cgroupstats.h [edit]
[-] i8k.h [edit]
[-] cciss_ioctl.h [edit]
[-] major.h [edit]
[-] nfs_fs.h [edit]
[-] rfkill.h [edit]
[-] atm.h [edit]
[-] fuse.h [edit]
[-] fsl_hypervisor.h [edit]
[-] atalk.h [edit]
[-] ivtv.h [edit]
[-] nfs4_mount.h [edit]
[-] pps.h [edit]
[-] nubus.h [edit]
[-] ethtool.h [edit]
[-] hpet.h [edit]
[-] atmmpc.h [edit]
[-] fou.h [edit]
[-] dccp.h [edit]
[-] if_pppox.h [edit]
[-] media.h [edit]
[-] dm-log-userspace.h [edit]
[-] ndctl.h [edit]
[-] wmi.h [edit]
[-] timex.h [edit]
[-] mii.h [edit]
[-] kd.h [edit]
[-] if_pppol2tp.h [edit]
[-] uinput.h [edit]
[-] time.h [edit]
[-] fadvise.h [edit]
[-] phonet.h [edit]
[-] dlm_device.h [edit]
[-] bpf_perf_event.h [edit]
[-] quota.h [edit]
[-] ppdev.h [edit]
[-] ivtvfb.h [edit]
[-] if_plip.h [edit]
[-] net_namespace.h [edit]
[-] ipmi.h [edit]
[-] vhost.h [edit]
[-] v4l2-common.h [edit]
[-] ultrasound.h [edit]
[-] lp.h [edit]
[-] wireless.h [edit]
[-] keyctl.h [edit]
[-] atm_idt77105.h [edit]
[-] bt-bmc.h [edit]
[-] netrom.h [edit]
[-] rtc.h [edit]
[-] types.h [edit]
[-] qnxtypes.h [edit]
[-] affs_hardblocks.h [edit]
[-] if_ppp.h [edit]
[-] prctl.h [edit]
[-] firewire-cdev.h [edit]
[-] sdla.h [edit]
[-] atmbr2684.h [edit]
[-] falloc.h [edit]
[-] connector.h [edit]
[+] mmc
[-] rtnetlink.h [edit]
[-] tty_flags.h [edit]
[-] bpf.h [edit]
[-] watchdog.h [edit]
[-] bsg.h [edit]
[-] kernel.h [edit]
[-] reiserfs_fs.h [edit]
[+] can
[-] selinux_netlink.h [edit]
[-] hdlcdrv.h [edit]
[-] filter.h [edit]
[-] hidraw.h [edit]
[-] icmp.h [edit]
[-] uio.h [edit]
[-] if_ltalk.h [edit]
[-] ppp-ioctl.h [edit]
[-] vtpm_proxy.h [edit]
[-] elfcore.h [edit]
[-] limits.h [edit]
[-] if_tunnel.h [edit]
[-] if_fddi.h [edit]
[-] uvcvideo.h [edit]
[-] ioctl.h [edit]
[-] capi.h [edit]
[-] nvme_ioctl.h [edit]
[-] dlm.h [edit]
[-] tiocl.h [edit]
[-] inotify.h [edit]
[-] poll.h [edit]
[-] rose.h [edit]
[-] if_hippi.h [edit]
[-] matroxfb.h [edit]
[-] i2o-dev.h [edit]
[-] tipc_config.h [edit]
[-] ipsec.h [edit]
[-] dlm_netlink.h [edit]
[-] serio.h [edit]
[-] cdrom.h [edit]
[-] fanotify.h [edit]
[-] virtio_blk.h [edit]
[-] atmioc.h [edit]
[-] securebits.h [edit]
[-] bpf_common.h [edit]
[-] if_team.h [edit]
[-] omapfb.h [edit]
[-] pktcdvd.h [edit]
[-] phantom.h [edit]
[-] atmapi.h [edit]
[-] hyperv.h [edit]
[-] stddef.h [edit]
[-] vt.h [edit]
[-] cycx_cfm.h [edit]
[-] parport.h [edit]
[-] ptrace.h [edit]
[-] nfs.h [edit]
[-] if_bridge.h [edit]
[+] netfilter_bridge
[-] unix_diag.h [edit]
[-] times.h [edit]
[-] n_r3964.h [edit]
[-] nl80211.h [edit]
[-] kvm.h [edit]
[-] virtio_ring.h [edit]
[-] bpqether.h [edit]
[-] ip6_tunnel.h [edit]
[-] sem.h [edit]
[-] llc.h [edit]
[-] omap3isp.h [edit]
[-] virtio_types.h [edit]
[-] xattr.h [edit]
[-] netfilter.h [edit]
[-] edd.h [edit]
[-] inet_diag.h [edit]
[-] vfio.h [edit]
[-] un.h [edit]
[-] termios.h [edit]
[+] usb
[-] firewire-constants.h [edit]
[-] nfs4.h [edit]
[-] atmclip.h [edit]
[-] devlink.h [edit]
[-] ip_vs.h [edit]
[-] nfc.h [edit]
[-] flat.h [edit]
[-] elf.h [edit]
[-] if_x25.h [edit]
[-] mdio.h [edit]
[-] isdn_ppp.h [edit]
[+] isdn
[-] cm4000_cs.h [edit]
[-] nvram.h [edit]
[-] param.h [edit]
[-] dlm_plock.h [edit]
[-] virtio_balloon.h [edit]
[-] telephony.h [edit]
[-] dlmconstants.h [edit]
[-] tcp.h [edit]
[-] futex.h [edit]
[-] virtio_scsi.h [edit]
[-] net.h [edit]
[-] sonypi.h [edit]
[-] wait.h [edit]
[-] apm_bios.h [edit]
[-] if_macsec.h [edit]
[+] hsi
[-] gigaset_dev.h [edit]
[-] capability.h [edit]
[-] errqueue.h [edit]
[+] netfilter
[-] a.out.h [edit]
[-] utsname.h [edit]
[-] gen_stats.h [edit]
[-] kdev_t.h [edit]
[-] if_vlan.h [edit]
[-] lwtunnel.h [edit]
[-] uhid.h [edit]
[-] i2c-dev.h [edit]
[-] wimax.h [edit]
[-] openvswitch.h [edit]
[-] virtio_input.h [edit]
[-] sonet.h [edit]
[+] hdlc
[-] ppp-comp.h [edit]
[-] veth.h [edit]
[-] atmsvc.h [edit]
[-] netlink_diag.h [edit]
[-] hid.h [edit]
[-] const.h [edit]
[-] psample.h [edit]
[-] vm_sockets.h [edit]
[-] i2c.h [edit]
[-] synclink.h [edit]
[-] if_arp.h [edit]
[-] pfkeyv2.h [edit]
[-] virtio_config.h [edit]
[-] if_fc.h [edit]
[-] eventpoll.h [edit]
[-] binfmts.h [edit]
[-] soundcard.h [edit]
[-] in6.h [edit]
[-] b1lli.h [edit]
[-] suspend_ioctls.h [edit]
[-] loop.h [edit]
[-] seccomp.h [edit]
[-] blktrace_api.h [edit]
[-] adfs_fs.h [edit]
[-] netdevice.h [edit]
[-] virtio_console.h [edit]
[-] dqblk_xfs.h [edit]
[-] netfilter_decnet.h [edit]
[-] mmtimer.h [edit]
[-] can.h [edit]
[-] adb.h [edit]
[-] acct.h [edit]
[-] ax25.h [edit]
[-] coda_psdev.h [edit]
[-] elf-fdpic.h [edit]
[-] virtio_rng.h [edit]
[-] signal.h [edit]
[-] libc-compat.h [edit]
[-] taskstats.h [edit]
[-] ncp_no.h [edit]
[-] ipx.h [edit]
[-] userfaultfd.h [edit]
[-] mempolicy.h [edit]
[-] icmpv6.h [edit]
[-] atmarp.h [edit]
[-] if_frad.h [edit]
[-] signalfd.h [edit]
[-] irda.h [edit]
[-] fiemap.h [edit]
[-] virtio_pci.h [edit]
[-] if_cablemodem.h [edit]
[-] in_route.h [edit]
[-] mpls.h [edit]
[-] input.h [edit]
[-] nfs_idmap.h [edit]
[-] cramfs_fs.h [edit]
[-] ptp_clock.h [edit]
[-] audit.h [edit]
[-] if_tun.h [edit]
[-] igmp.h [edit]
[-] if_alg.h [edit]
[-] random.h [edit]
[-] netfilter_ipv4.h [edit]
[-] atm_nicstar.h [edit]
[-] packet_diag.h [edit]
[-] x25.h [edit]
[+] tc_act
[-] in.h [edit]
[-] irqnr.h [edit]
[-] ncp.h [edit]
[-] reiserfs_xattr.h [edit]
[+] iio
[-] fs.h [edit]
[-] map_to_7segment.h [edit]
[+] sunrpc
[-] if_addr.h [edit]
[-] mtio.h [edit]
[+] nfsd
[-] hysdn_if.h [edit]
[-] pci_regs.h [edit]
[-] mroute6.h [edit]
[-] isdn.h [edit]
[-] udf_fs_i.h [edit]