1ENUM WIMAX_ST(9)               Linux Networking               ENUM WIMAX_ST(9)
2
3
4

NAME

6       enum_wimax_st - The different states of a WiMAX device
7

SYNOPSIS

9       enum wimax_st {
10         __WIMAX_ST_NULL,
11         WIMAX_ST_DOWN,
12         __WIMAX_ST_QUIESCING,
13         WIMAX_ST_UNINITIALIZED,
14         WIMAX_ST_RADIO_OFF,
15         WIMAX_ST_READY,
16         WIMAX_ST_SCANNING,
17         WIMAX_ST_CONNECTING,
18         WIMAX_ST_CONNECTED,
19         __WIMAX_ST_INVALID
20       };
21

CONSTANTS

23       __WIMAX_ST_NULL
24           The device structure has been allocated and zeroed, but still
25           wimax_dev_add hasn't been called. There is no state.
26
27       WIMAX_ST_DOWN
28           The device has been registered with the WiMAX and networking
29           stacks, but it is not initialized (normally that is done with
30           'ifconfig DEV up' [or equivalent], which can upload firmware and
31           enable communications with the device). In this state, the device
32           is powered down and using as less power as possible. This state is
33           the default after a call to wimax_dev_add. It is ok to have drivers
34           move directly to WIMAX_ST_UNINITIALIZED or WIMAX_ST_RADIO_OFF in
35           _probe after the call to wimax_dev_add. It is recommended that the
36           driver leaves this state when calling 'ifconfig DEV up' and enters
37           it back on 'ifconfig DEV down'.
38
39       __WIMAX_ST_QUIESCING
40           The device is being torn down, so no API operations are allowed to
41           proceed except the ones needed to complete the device clean up
42           process.
43
44       WIMAX_ST_UNINITIALIZED
45           [optional] Communication with the device is setup, but the device
46           still requires some configuration before being operational. Some
47           WiMAX API calls might work.
48
49       WIMAX_ST_RADIO_OFF
50           The device is fully up; radio is off (wether by hardware or
51           software switches). It is recommended to always leave the device in
52           this state after initialization.
53
54       WIMAX_ST_READY
55           The device is fully up and radio is on.
56
57       WIMAX_ST_SCANNING
58           [optional] The device has been instructed to scan. In this state,
59           the device cannot be actively connected to a network.
60
61       WIMAX_ST_CONNECTING
62           The device is connecting to a network. This state exists because in
63           some devices, the connect process can include a number of
64           negotiations between user space, kernel space and the device. User
65           space needs to know what the device is doing. If the connect
66           sequence in a device is atomic and fast, the device can transition
67           directly to CONNECTED
68
69       WIMAX_ST_CONNECTED
70           The device is connected to a network.
71
72       __WIMAX_ST_INVALID
73           This is an invalid state used to mark the maximum numeric value of
74           states.
75

DESCRIPTION

77       Transitions from one state to another one are atomic and can only be
78       caused in kernel space with wimax_state_change. To read the state, use
79       wimax_state_get.
80
81       States starting with __ are internal and shall not be used or referred
82       to by drivers or userspace. They look ugly, but that's the point -- if
83       any use is made non-internal to the stack, it is easier to catch on
84       review.
85
86       All API operations [with well defined exceptions] will take the device
87       mutex before starting and then check the state. If the state is
88       __WIMAX_ST_NULL, WIMAX_ST_DOWN, WIMAX_ST_UNINITIALIZED or
89       __WIMAX_ST_QUIESCING, it will drop the lock and quit with -EINVAL,
90       -ENOMEDIUM, -ENOTCONN or -ESHUTDOWN.
91
92       The order of the definitions is important, so we can do numerical
93       comparisons (eg: < WIMAX_ST_RADIO_OFF means the device is not ready to
94       operate).
95

97Kernel Hackers Manual 2.6.       November 2011                ENUM WIMAX_ST(9)
Impressum