dexter has uploaded this change for review.

View Change

README.md add section about device compatibility

To give potential users an estimate on which android devices the APDU proxy
may work, let's explain a bit about which Android releases have OMAPI and
which not. Let's also add a table with devices with which we have tested
the APDU proxy successfully.

Change-Id: I64459bbe2920c7381ab75e422bf317ad21c8b8cc
Related: OS#6367
---
M README.md
1 file changed, 30 insertions(+), 1 deletion(-)

git pull ssh://gerrit.osmocom.org:29418/android-apdu-proxy refs/changes/56/38856/1

diff --git a/README.md b/README.md
index 37efb2a..8a5765b 100644
--- a/README.md
+++ b/README.md
@@ -264,4 +264,33 @@
 ```
 
 To make sure that the re-signing was successful the apksigner utility can be
-used as already described in section `Signing and ARA-M configuration`
\ No newline at end of file
+used as already described in section `Signing and ARA-M configuration`
+
+Device compatibility
+--------------------
+
+Unfortunately Android APDU proxy does not run on any old Android device. It
+requires an Android device with at least Android 9 (API level 28), which
+was introduced in 2018.
+
+Only Android devices with Android 9 or higher will have the `OMAPI`
+interface that Android APDU proxy needs to access the UICC/eUICC. However,
+even if the Android device has OMAPI support, it is not guaranteed that it
+can be used to access the UICC/eUICC cards. This depends on the specific
+hardware/firmware properties of the device itself. With Android 11 (API level
+30), a feature flag `FEATURE_SE_OMAPI_UICC` was introduced that allows checking
+for OMAPI UICC/eUICC support explicitly. Android APDU proxy checks this flag
+(if present) and will generate an error message in case UICC/eUICC access is
+not possible.
+
+During development we have tested Android APDU proxy successfully on the
+following Android devices.
+
+| Brand    | Model                          | Android version | API level |
+| -------- | ------------------------------ | --------------- | --------- |
+| Samsung  | SM-A217F/DSN (Galaxy A21s)     | 10              | 29        |
+| ONEPLUS  | A6013                          | 11              | 30        |
+| CAT      | S62Pro                         | 11              | 30        |
+| Google   | Pixel7a                        | 13              | 33        |
+| Google   | Pixel4a                        | 14              | 34        |
+| SAMSUNG  | SM-G990B/DS (Galaxy S21 FE 5G) | 14              | 34        |

To view, visit change 38856. To unsubscribe, or for help writing mail filters, visit settings.