/*
 * Copyright (C) 2014 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    nomac Link layer with no medium access
 * @ingroup     net
 * @brief       Link layer protocol to speak with any transceiver driver
 *              directly without any medium access.
 * @{
 *
 * @file
 * @brief       Link layer protocol to speak with any transceiver driver
 *              directly without any medium access.
 *
 * @author      Martine Lenders <mlenders@inf.fu-berlin.de>
 */

#ifndef __NOMAC_H_
#define __NOMAC_H_

#include <stdlib.h>

#include "netdev/base.h"
#include "netapi.h"

#ifdef __cplusplus
extern "C" {
#endif

#ifndef NOMAC_REGISTRY_SIZE
/**
 * @brief   The size of NOMAC's registry of receiving threads.
 */
#define NOMAC_REGISTRY_SIZE (1)
#endif

/**
 * @brief   Recommended stack size for a NOMAC thread
 * TODO: determine real minimal size based on thread_print_all() output
 */
#define NOMAC_CONTROL_STACKSIZE    (KERNEL_CONF_STACKSIZE_DEFAULT)

/**
 * @brief   Basic configuration types
 *
 * @extends netapi_conf_type_t
 */
typedef enum {
    NOMAC_PROTO = NETAPI_CONF_PROTO,            /**< Set or get protocol */
    NOMAC_CHANNEL = NETAPI_CONF_CARRIER,        /**< Set or get channel */
    NOMAC_ADDRESS = NETAPI_CONF_ADDRESS,        /**< Set or get address */
    NOMAC_NID = NETAPI_CONF_SUBNETS,            /**< Set or get network id
                                                 *   (e.g. PAN ID in 802.15.4)*/
    NOMAC_MAX_PACKET_SIZE = NETAPI_CONF_MAX_PACKET_SIZE,    /**< Set or get maximum
                                                             *   packet size */
    NOMAC_SRC_LEN = NETAPI_CONF_SRC_LEN,        /**< Set or get default source length */
    NOMAC_REGISTRY = NETAPI_CONF_REGISTRY,      /**< get registered threads */
    NOMAC_ADDRESS2 = NETDEV_OPT_ADDRESS_LONG,   /**< Set or get alternative address
                                                 *   format (e.g EUI-64 in 802.15.4) */
} nomac_conf_type_t;

/**
 * @brief   Initializes the module
 */
void nomac_init_module(void);

/**
 * @brief   Initialize new NOMAC layer.
 *
 * @param[in] stack     Stack for the control thread
 * @param[in] stacksize Size of *stack*
 * @param[in] priority  Priority for the control thread
 * @param[in] name      Name for the control thread
 * @param[in] dev       An *initialized* network device to use with this MAC
 *                      layer
 *
 * @see @ref thread_create
 *
 * @return  PID of NOMAC control thread on success
 * @return  -EINVAL if priority is invalid
 * @return  -EOVERFLOW if no slot for the new thread is available
 */
kernel_pid_t nomac_init(char *stack, int stacksize, char priority,
                        const char *name, netdev_t *dev);

#ifdef MODULE_NETDEV_DUMMY
/**
 * @brief   Re-updates the receive callback of a network device for testing
 *          purposes
 *
 * @param[in] dev   A network device
 */
void nomac_update_callback(netdev_t *dev);
#endif

#ifdef __cplusplus
}
#endif

#endif /* __NOMAC_H_ */

/** @} */