abc/lwip
1
0
Fork 0
mirror of https://git.savannah.nongnu.org/git/lwip.git synced 2026-05-27 18:47:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Minor: Several documentation updates

Browse Source
This commit is contained in:
Dirk Ziegelmeier
2016-08-25 22:04:04 +02:00
parent 452f5d6296
commit 57468b8a30
4 changed files with 33 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/include/lwip/netif.h
View File

@@ -359,17 +359,17 @@ void netif_set_default(struct netif *netif);
void netif_set_ipaddr(struct netif *netif, const ip4_addr_t *ipaddr);
void netif_set_netmask(struct netif *netif, const ip4_addr_t *netmask);
void netif_set_gw(struct netif *netif, const ip4_addr_t *gw);
/** @ingroup netif */
/** @ingroup netif_ip4 */
#define netif_ip4_addr(netif) ((const ip4_addr_t*)ip_2_ip4(&((netif)->ip_addr)))
/** @ingroup netif */
/** @ingroup netif_ip4 */
#define netif_ip4_netmask(netif) ((const ip4_addr_t*)ip_2_ip4(&((netif)->netmask)))
/** @ingroup netif */
/** @ingroup netif_ip4 */
#define netif_ip4_gw(netif) ((const ip4_addr_t*)ip_2_ip4(&((netif)->gw)))
/** @ingroup netif */
/** @ingroup netif_ip4 */
#define netif_ip_addr4(netif) ((const ip_addr_t*)&((netif)->ip_addr))
/** @ingroup netif */
/** @ingroup netif_ip4 */
#define netif_ip_netmask4(netif) ((const ip_addr_t*)&((netif)->netmask))
/** @ingroup netif */
/** @ingroup netif_ip4 */
#define netif_ip_gw4(netif) ((const ip_addr_t*)&((netif)->gw))
#endif /* LWIP_IPV4 */
@@ -429,9 +429,9 @@ u8_t netif_alloc_client_data_id(void);
#endif
#if LWIP_IPV6
/** @ingroup netif */
/** @ingroup netif_ip6 */
#define netif_ip_addr6(netif, i) ((const ip_addr_t*)(&((netif)->ip6_addr[i])))
/** @ingroup netif */
/** @ingroup netif_ip6 */
#define netif_ip6_addr(netif, i) ((const ip6_addr_t*)ip_2_ip6(&((netif)->ip6_addr[i])))
void netif_ip6_addr_set(struct netif *netif, s8_t addr_idx, const ip6_addr_t *addr6);
void netif_ip6_addr_set_parts(struct netif *netif, s8_t addr_idx, u32_t i0, u32_t i1, u32_t i2, u32_t i3);

14
src/include/lwip/opt.h
View File

@@ -2494,19 +2494,21 @@
#endif
/**
* LWIP_HOOK_VLAN_SET(netif, eth_hdr, vlan_hdr):
* LWIP_HOOK_VLAN_SET:
* Hook can be used to set prio_vid field of vlan_hdr.
* Called from ethernet_output() if VLAN support is enabled.
* Signature: s32_t my_hook_vlan_set(struct netif* netif, struct pbuf* pbuf, const struct eth_addr* src, const struct eth_addr* dst, u16_t eth_type);
* Called from ethernet_output() if VLAN support (@ref ETHARP_SUPPORT_VLAN) is enabled.\n
* Signature: s32_t my_hook_vlan_set(struct netif* netif, struct pbuf* pbuf, const struct eth_addr* src, const struct eth_addr* dst, u16_t eth_type);\n
* Arguments:
* - netif: struct netif that the packet will be sent through
* - p: struct pbuf packet to be sent
* - src: source eth address
* - dst: destination eth address
* - eth_type: ethernet type to packet to be sent
* - eth_type: ethernet type to packet to be sent\n
*
*
* Return values:
* - <0: Packet shall not contain VLAN header.
* - 0 <= return value <= 0xFFFF: Packet shall contain VLAN header. Return value is prio_vid in host byte order.
* - &lt;0: Packet shall not contain VLAN header.
* - 0 &lt;= return value &lt;= 0xFFFF: Packet shall contain VLAN header. Return value is prio_vid in host byte order.
*/
#ifdef __DOXYGEN__
#define LWIP_HOOK_VLAN_SET(netif, p, src, dst, eth_type)