33d59f8148
Add \since and \version doxygen tags to the networking APIs, so that they render correctly on the API overview page. The version used for \since tag was determined, based on the commit that introduced the header or in individual cases, when the API was introduced as a part of a larger header (mostly apply for the oldest, core network APIs). The version of the API was set as follows: * components that use EXPERIMENTAL Kconfig symbol were assigned with 0.1.0 * The oldest, "core" networking APIs were marked as "stable" (1.0.0). * Everything else ended up as "unstable" (0.8.0). Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
69 lines
1.5 KiB
C
69 lines
1.5 KiB
C
/*
|
|
* Copyright (c) 2018 Intel Corporation.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/** @file
|
|
* @brief Dummy layer 2
|
|
*
|
|
* This is not to be included by the application.
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_NET_DUMMY_H_
|
|
#define ZEPHYR_INCLUDE_NET_DUMMY_H_
|
|
|
|
#include <zephyr/net/net_if.h>
|
|
#include <zephyr/net/net_pkt.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Dummy L2/driver support functions
|
|
* @defgroup dummy Dummy L2/driver Support Functions
|
|
* @since 1.14
|
|
* @version 0.8.0
|
|
* @ingroup networking
|
|
* @{
|
|
*/
|
|
|
|
/** Dummy L2 API operations. */
|
|
struct dummy_api {
|
|
/**
|
|
* The net_if_api must be placed in first position in this
|
|
* struct so that we are compatible with network interface API.
|
|
*/
|
|
struct net_if_api iface_api;
|
|
|
|
/** Send a network packet */
|
|
int (*send)(const struct device *dev, struct net_pkt *pkt);
|
|
|
|
/**
|
|
* Receive a network packet (only limited use for this, for example
|
|
* receiving capturing packets and post processing them).
|
|
*/
|
|
enum net_verdict (*recv)(struct net_if *iface, struct net_pkt *pkt);
|
|
|
|
/** Start the device. Called when the bound network interface is brought up. */
|
|
int (*start)(const struct device *dev);
|
|
|
|
/** Stop the device. Called when the bound network interface is taken down. */
|
|
int (*stop)(const struct device *dev);
|
|
};
|
|
|
|
/* Make sure that the network interface API is properly setup inside
|
|
* dummy API struct (it is the first one).
|
|
*/
|
|
BUILD_ASSERT(offsetof(struct dummy_api, iface_api) == 0);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* ZEPHYR_INCLUDE_NET_DUMMY_H_ */
|