aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSzczepan Zalega <szczepan@nitrokey.com>2019-06-13 14:07:57 +0200
committerSzczepan Zalega <szczepan@nitrokey.com>2019-06-13 15:00:56 +0200
commitae95a590a652cd17c82dbef4098ac496485c7cbd (patch)
tree72b3d6b6c863ab0512cfd22427d3f218983be35c
parenta0efa194383f345cf266df933520ae0807a7e5b7 (diff)
downloadlibnitrokey-ae95a590a652cd17c82dbef4098ac496485c7cbd.tar.gz
libnitrokey-ae95a590a652cd17c82dbef4098ac496485c7cbd.tar.bz2
Add documentation of new commands to the C API
Signed-off-by: Szczepan Zalega <szczepan@nitrokey.com>
-rw-r--r--NK_C_API.h15
1 files changed, 12 insertions, 3 deletions
diff --git a/NK_C_API.h b/NK_C_API.h
index 7376c9f..9383cd9 100644
--- a/NK_C_API.h
+++ b/NK_C_API.h
@@ -979,11 +979,20 @@ extern "C" {
/**
- * FIXME DOC
- * @param update_password
- * @return
+ * Enable update mode on Nitrokey Pro.
+ * Supported from v0.11.
+ * @param update_password 20 bytes update password
+ * @return command processing error code
*/
NK_C_API int NK_enable_firmware_update_pro(const char* update_password);
+
+ /**
+ * Change update-mode password on Nitrokey Pro.
+ * Supported from v0.11.
+ * @param current_firmware_password 20 bytes update password
+ * @param new_firmware_password 20 bytes update password
+ * @return command processing error code
+ */
NK_C_API int NK_change_firmware_password_pro(const char *current_firmware_password, const char *new_firmware_password);
#ifdef __cplusplus