---
name: "enum_wimax_st"
section: "9"
platform: "linux"
package: "linux-manual-4.9"
version: "4.9.228-1"
release: "Debian 9 (Stretch)"
platforms: ["linux"]
url: "https://new.carta.tech/enum_wimax_st"
---

# enum\_wimax\_st(9)

The different states of a WiMAX device

## NAME

enum\_wimax\_st - The different states of a WiMAX device

## SYNOPSIS

```
enum wimax_st {
  __WIMAX_ST_NULL,
  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
};
```

## CONSTANTS

\_\_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).

## COPYRIGHT