usbspace.h

Go to the documentation of this file.

#ifndef EVE_NET_NETSPACE_H_INCLUDED
#define EVE_NET_NETSPACE_H_INCLUDED
/**********************************************************************/
/*
 * Copyright (c) 2014-2016, Jetro AS
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Shared USB buffer space

 * @author DT, Jetro AS
 */ /******************************************************************/

#include <net/common/usbnet.h>

/**
 * \addtogroup net_common
 * @{
 */

/**
 * The USB buffer space union contains all possible mutually exclusive
 * variants of using the shared USB memory area by different USB protocols.
 * Note that the buffers can not be used simultaneously by the protocols.
 */
union netspace_t {
  struct net_buffers_t netbuf;        /**< Usbnet buffers */
};

/**
 * The physical USB buffers memory block.
 */
extern union netspace_t netspace;

/** @} */ /* common */
/** @} */ /* net */
/** @} */ /* eve */

#endif /* EVE_NET_NETSPACE_H_INCLUDED */