From b0bb01d80837911cd7e5ccfe41d45e476e50d2fe Mon Sep 17 00:00:00 2001
From: Ningyuan Wang <nywang@google.com>
Date: Thu, 13 Apr 2017 10:39:27 -0700
Subject: [PATCH] wifi(interface): Add links to APF docs

Bug: 32119512
Test: Compiles
Merged-In: Iadb68a2a649b120b607735e4d88617b11740832f
Change-Id: I32ec491983d1d9e987a19a00b4fd8e60503c9e7f
---
 wifi/1.0/IWifiStaIface.hal | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/wifi/1.0/IWifiStaIface.hal b/wifi/1.0/IWifiStaIface.hal
index 43c312659e..644e78a4e5 100644
--- a/wifi/1.0/IWifiStaIface.hal
+++ b/wifi/1.0/IWifiStaIface.hal
@@ -145,6 +145,31 @@ interface IWifiStaIface extends IWifiIface {
    * program if present.
    * Must fail if |StaIfaceCapabilityMask.APF| is not set.
    *
+   * APF docs
+   * ==========================================================================
+   * APF functionality, instructions and bytecode/binary format is described in:
+   * http://android.googlesource.com/platform/hardware/google/apf/
+   * +/b75c9f3714cfae3dad3d976958e063150781437e/apf.h
+   *
+   * The interpreter API is described here:
+   * http://android.googlesource.com/platform/hardware/google/apf/+/
+   * b75c9f3714cfae3dad3d976958e063150781437e/apf_interpreter.h#32
+   *
+   * The assembler/generator API is described in javadocs here:
+   * http://android.googlesource.com/platform/frameworks/base/+/
+   * 4456f33a958a7f09e608399da83c4d12b2e7d191/services/net/java/android/net/
+   * apf/ApfGenerator.java
+   *
+   * Disassembler usage is described here:
+   * http://android.googlesource.com/platform/hardware/google/apf/+/
+   * b75c9f3714cfae3dad3d976958e063150781437e/apf_disassembler.c#65
+   *
+   * The BPF to APF translator usage is described here:
+   * http://android.googlesource.com/platform/frameworks/base/+/
+   * 4456f33a958a7f09e608399da83c4d12b2e7d191/tests/net/java/android/net/
+   * apf/Bpf2Apf.java
+   * ==========================================================================
+   *
    * @param cmdId command Id to use for this invocation.
    * @param APF Program to be set.
    * @return status WifiStatus of the operation.