*/
/**
- * @mainpage
+ * @mainpage
* @section Introduction
- * The Atheros Driver Framework provides a mechanism to run the Atheros
+ * The Atheros Driver Framework provides a mechanism to run the Atheros
* WLAN driver on a variety of Operating Systems and Platforms. It achieves
* this by abstracting all OS-specific and platform-specific functionality
* the driver requires. This ensures the core logic in the driver is OS-
* This component abstracts the OS network buffer. See @ref adf_nbuf_public for details.
* @subsection sec3 OS services
* This component abstracts any OS services. See @ref adf_os_public for details.
- */
+ */
#ifndef _ADF_NET_H
#define _ADF_NET_H
/*
* check for a NULL handle
* */
-#define ADF_NET_NULL __ADF_NET_NULL
+#define ADF_NET_NULL __ADF_NET_NULL
/**
* @brief this register the driver to the shim, but won't get
* any handle until create device is called.
- *
+ *
* @param[in] drv driver info structure
- *
+ *
* @return status of operation
*/
-static inline a_status_t
+static inline a_status_t
adf_net_register_drv(adf_drv_info_t *drv)
{
return(__adf_net_register_drv(drv));
/**
* @brief deregister the driver from the shim
- *
+ *
* @param[in] name driver name passed in adf_drv_info_t
*
* @see adf_net_register_drv()
/**
* @brief register a real device with the kernel
- *
+ *
* @param[in] hdl driver handle for this device
* @param[in] op per-device switch structure
* @param[in] info basic device information
- *
+ *
* @return opaque device handle
*/
-static inline adf_net_handle_t
-adf_net_dev_create(adf_drv_handle_t hdl,
- adf_dev_sw_t *op,
+static inline adf_net_handle_t
+adf_net_dev_create(adf_drv_handle_t hdl,
+ adf_dev_sw_t *op,
adf_net_dev_info_t *info)
{
return (__adf_net_dev_create(hdl, op, info));
/**
* @brief register a virtual device with the kernel.
* A virtual device is always backed by a real device.
- *
+ *
* @param[in] dev_hdl opaque device handle for the real device
* @param[in] hdl driver handle for this virtual device
* @param[in] op per-virtual-device switch structure
* @param[in] info basic virtual device information
- *
+ *
* @return opaque device handle
*
* @see adf_net_dev_create()
*/
-static inline adf_net_handle_t
-adf_net_vdev_create(adf_net_handle_t dev_hdl,
- adf_drv_handle_t hdl,
- adf_vdev_sw_t *op,
- adf_net_dev_info_t *info)
+static inline adf_net_handle_t
+adf_net_vdev_create(adf_net_handle_t dev_hdl,
+ adf_drv_handle_t hdl,
+ adf_vdev_sw_t *op,
+ adf_net_dev_info_t *info)
{
return (__adf_net_vdev_create(dev_hdl, hdl, op, info));
}
/**
* @brief Checks if the interface is running or not
- *
+ *
* @param[in] hdl opaque device handle
- *
+ *
* @return true if running, false if not
*/
static inline a_bool_t
/**
* @brief Checks if the interface is up or not
- *
+ *
* @param[in] hdl opaque device handle
- *
+ *
* @return true if up, false if not
*/
static inline a_bool_t
/**
* @brief check whether the carrier is available or not
- *
+ *
* @param[in] hdl opaque device handle
- *
+ *
* @return a_bool_t true if available, false if not
*/
-static inline a_bool_t
+static inline a_bool_t
adf_net_carrier_ok(adf_net_handle_t hdl)
{
return(__adf_net_carrier_ok(hdl));
/**
* @brief inform the networking stack that the link is down
- *
+ *
* @param[in] hdl opaque device handle
*/
-static inline void
+static inline void
adf_net_carrier_off(adf_net_handle_t hdl)
{
__adf_net_carrier_off(hdl);
/**
* @brief inform the networking stack that the link is up
- *
+ *
* @param[in] hdl opaque device handle
- *
+ *
* @see adf_net_carrier_off()
*/
-static inline void
+static inline void
adf_net_carrier_on(adf_net_handle_t hdl)
{
__adf_net_carrier_on(hdl);
*/
/**
- * @brief inform the networking stack that the device is ready to receive
+ * @brief inform the networking stack that the device is ready to receive
* transmit packets. Typically called during init.
- *
+ *
* @param[in] hdl opaque device handle
*/
-static inline void
+static inline void
adf_net_start_queue(adf_net_handle_t hdl)
{
__adf_net_start_queue(hdl);
/**
* @brief inform the networking stack to stop sending transmit packets.
* Typically called if the driver runs out of resources for the device.
- *
+ *
* @param[in] hdl opaque device handle
*/
-static inline void
+static inline void
adf_net_stop_queue(adf_net_handle_t hdl)
{
__adf_net_stop_queue(hdl);
/**
* @brief inform the native stack to resume sending packets
* to transmit.Typically called when the driver has resources
- * available again for the device.
+ * available again for the device.
*
* @note adf_net_wake_queue() is the counterpart of adf_net_stop_queue()
*
* @param[in] hdl opaque device handle
*/
-static inline void
+static inline void
adf_net_wake_queue(adf_net_handle_t hdl)
{
__adf_net_wake_queue(hdl);
/**
* @brief Check the state of the queue
- *
+ *
* @param[in] hdl opaque device handle
- *
+ *
* @return true if stopped, false if not
*/
-static inline a_bool_t
+static inline a_bool_t
adf_net_queue_stopped(adf_net_handle_t hdl)
{
return(__adf_net_queue_stopped(hdl));
/**
* @brief get interface name
- *
+ *
* @param[in] hdl opaque device handle
- *
+ *
* @return name of interface
*/
static inline const a_uint8_t *
* @brief Get OS Handle from OS device object.
*
* @param[in] osdev OS device object
- *
+ *
* @return OS handle
- */
+ */
static inline adf_os_handle_t
adf_net_dev_to_os(adf_os_device_t osdev)
{
* @brief Get OS Handle from OS net handle.
*
* @param[in] osdev OS net handle
- *
+ *
* @return OS handle
- */
+ */
static inline adf_os_handle_t
adf_net_hdl_to_os(adf_net_handle_t hdl)
{