From patchwork Thu Jan 28 15:05:00 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bill Fischofer X-Patchwork-Id: 60737 Delivered-To: patch@linaro.org Received: by 10.112.130.2 with SMTP id oa2csp532343lbb; Thu, 28 Jan 2016 07:06:33 -0800 (PST) X-Received: by 10.140.28.69 with SMTP id 63mr4152071qgy.66.1453993593611; Thu, 28 Jan 2016 07:06:33 -0800 (PST) Return-Path: Received: from lists.linaro.org (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTP id y205si11926717qhc.111.2016.01.28.07.06.33; Thu, 28 Jan 2016 07:06:33 -0800 (PST) Received-SPF: pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) client-ip=54.225.227.206; Authentication-Results: mx.google.com; spf=pass (google.com: domain of lng-odp-bounces@lists.linaro.org designates 54.225.227.206 as permitted sender) smtp.mailfrom=lng-odp-bounces@lists.linaro.org; dkim=neutral (body hash did not verify) header.i=@linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id 2D28F617D6; Thu, 28 Jan 2016 15:06:33 +0000 (UTC) Authentication-Results: lists.linaro.org; dkim=fail reason="verification failed; unprotected key" header.d=linaro.org header.i=@linaro.org header.b=C9+AERr7; dkim-adsp=none (unprotected policy); dkim-atps=neutral X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on ip-10-142-244-252 X-Spam-Level: X-Spam-Status: No, score=-2.5 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_LOW, RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL, T_DKIM_INVALID, URIBL_BLOCKED autolearn=disabled version=3.4.0 Received: from [127.0.0.1] (localhost [127.0.0.1]) by lists.linaro.org (Postfix) with ESMTP id AA1C7617E0; Thu, 28 Jan 2016 15:05:26 +0000 (UTC) X-Original-To: lng-odp@lists.linaro.org Delivered-To: lng-odp@lists.linaro.org Received: by lists.linaro.org (Postfix, from userid 109) id C694B617E5; Thu, 28 Jan 2016 15:05:14 +0000 (UTC) Received: from mail-ob0-f169.google.com (mail-ob0-f169.google.com [209.85.214.169]) by lists.linaro.org (Postfix) with ESMTPS id D6511617D6 for ; Thu, 28 Jan 2016 15:05:11 +0000 (UTC) Received: by mail-ob0-f169.google.com with SMTP id ny8so15871817obc.2 for ; Thu, 28 Jan 2016 07:05:11 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references; bh=c1BbNdawFfx171K225vZSNb17IxzmlM2ueAkiWyOW6g=; b=C9+AERr7meE+YEG0vAjAhNdghlzDaEUxd9+Xj1+Ryhpita853dlUW3sQ1irrieSCBe aQEza0wgZaW7MI0MXXYZ8oZ+Mxh2Ht+YknvSpCLHY9XxI6xF0/8aeKIVAPBmt5qyibB8 5/JIBXXmTYELmdSYqZbQAqFw9MyNOddnCs4Sg= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=c1BbNdawFfx171K225vZSNb17IxzmlM2ueAkiWyOW6g=; b=miMG2jvsb/5Imzsf+zOJNabjVmUZq6dqW1M/7h3Z4cZ+FxCcICzhjfcYwjSeWHwG1s qKvJNA3R7zOhqu31TroGAlZSBBZBNp90OyR18Mt5tFrGnZaTR/Ecn2+G7zgE+lCD7Utk 8U8UoJuhtz9NPAWI9qwCPIfAOnevSOm7BIp6Ancvf2hyStC0xAtiVlhpjiB3WQF4c579 5FQ0ckrCklml8KbgVRh6eGy2KMWfsqGKILudBECbJLRH4gC1AmrxxKjdtOwsJKaAfZLv bImpAMUn8qBDLuIiMeTlSwvsipjFyx3NT1MeY0enD82c1k1z6P9NtHPUwYAzOVoXe4tj plWg== X-Gm-Message-State: AG10YORuYENPvBGWJpdpgH2kcz2VEZmnpmh2Bq4V2O1ltRu+RxxcS3QBJsgitBR45HQfqBanvEo= X-Received: by 10.60.62.243 with SMTP id b19mr2605195oes.28.1453993511413; Thu, 28 Jan 2016 07:05:11 -0800 (PST) Received: from Ubuntu15.localdomain (cpe-66-68-129-43.austin.res.rr.com. [66.68.129.43]) by smtp.gmail.com with ESMTPSA id k186sm5632766oif.13.2016.01.28.07.05.10 (version=TLS1_2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 28 Jan 2016 07:05:10 -0800 (PST) From: Bill Fischofer To: lng-odp@lists.linaro.org Date: Thu, 28 Jan 2016 09:05:00 -0600 Message-Id: <1453993505-32024-2-git-send-email-bill.fischofer@linaro.org> X-Mailer: git-send-email 2.5.0 In-Reply-To: <1453993505-32024-1-git-send-email-bill.fischofer@linaro.org> References: <1453993505-32024-1-git-send-email-bill.fischofer@linaro.org> X-Topics: patch Subject: [lng-odp] [API-NEXT PATCHv5 1/6] api: packet: add bcast/mcast parse documentation X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.16 Precedence: list List-Id: "The OpenDataPlane \(ODP\) List" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: "lng-odp" Signed-off-by: Bill Fischofer --- include/odp/api/packet_flags.h | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/include/odp/api/packet_flags.h b/include/odp/api/packet_flags.h index 65fd3ce..7ea08f7 100644 --- a/include/odp/api/packet_flags.h +++ b/include/odp/api/packet_flags.h @@ -109,6 +109,9 @@ int odp_packet_has_eth(odp_packet_t pkt); /** * Check for Ethernet broadcast address * + * ODP recognizes the destination MAC address FF:FF:FF:FF:FF:FF as + * a broadcast address. All others are considered non-broadcast. + * * @param pkt Packet handle * @retval non-zero if Ethernet destination address is the broadcast address * @retval 0 if Ethernet destination address is not the broadcast address @@ -118,6 +121,8 @@ int odp_packet_has_eth_bcast(odp_packet_t pkt); /** * Check for Ethernet multicast address * + * ODP recognizes the destination MAC address as multicast if bit 7 is 1. + * * @param pkt Packet handle * @retval non-zero if Ethernet destination address is a multicast address * @retval 0 if Ethernet destination address is not a multicast address @@ -181,6 +186,11 @@ int odp_packet_has_ipv6(odp_packet_t pkt); /** * Check for IP broadcast address * + * For IPv4, ODP recognizes the destination IP address 255.255.255.255 as + * a broadcast address. All other addresses are considered non-broadcast. + * + * For IPv6, no destination addresses are recognized as broadcast addresses. + * * @param pkt Packet handle * @retval non-zero if IP destination address is a broadcast address * @retval 0 if IP destination address is not a broadcast address @@ -190,6 +200,12 @@ int odp_packet_has_ip_bcast(odp_packet_t pkt); /** * Check for IP multicast address * + * For IPv4 ODP recognizes destination IP addresses in the range 224.0.0.0 + * through 239.255.255.255 as multicast addresses. + * + * For IPv6 ODP recognizes destination IP addresses with prefixes FF00:: + * through FFFF:: as multicast addresses. + * * @param pkt Packet handle * @retval non-zero if IP destination address is a multicast address * @retval 0 if IP destination address is not a multicast address