From: Jan Wojtkowski <j.wojtkowski@samsung.com>
Date: Mon, 3 Feb 2025 07:43:06 +0000 (+0100)
Subject: Add high level documentation to HAL API
X-Git-Tag: accepted/tizen/unified/x/20250212.094505^0
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=5e5b062ab5c5d14074ebf0bac9d96216f652620e;p=platform%2Fhal%2Fapi%2Fsecurity.git

Add high level documentation to HAL API

Change-Id: I797dd2a311ab9f1a65b5149ec8849f26d59e8520
---

diff --git a/doc/hal_security_certs_doc.h b/doc/hal_security_certs_doc.h
new file mode 100644
index 0000000..b644f2e
--- /dev/null
+++ b/doc/hal_security_certs_doc.h
@@ -0,0 +1,50 @@
+/*
+ * Copyright (c) 2025 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+#ifndef __TIZEN_HAL_SECURITY_CERTS_DOC_H__
+#define __TIZEN_HAL_SECURITY_CERTS_DOC_H__
+
+
+/**
+ * @file hal_security_certs_doc.h
+ * @brief This file contains high level documentation of the HAL Security Certs module.
+ */
+
+/**
+ * @ingroup HALAPI_HAL_SECURITY
+ * @defgroup HALAPI_HAL_SECURITY_CERTS_MODULE Security Certs
+ * @brief The @ref HALAPI_HAL_SECURITY_CERTS_MODULE provides functions for device certificates and signing operations.
+ *
+ * @section HALAPI_HAL_SECURITY_CERTS_MODULE_HEADER Required Header
+ *   \#include <hal/hal-security-certs.h>
+ *
+ * @section HALAPI_HAL_SECURITY_CERTS_MODULE_OVERVIEW Overview
+ * The Security Certs provides functions for device certificates and signing operations.
+ *
+ * The Security Certs functions provide methods to:
+ * - Load/Unload for certs hal-backend module
+ * - Create/Free key context
+ * - Request certificate chain
+ * - Create signature
+ * - Get key type/length
+ * - Call extended api
+ * - Get extended api privilege
+ *
+ * For more information on the Security Certs features and the macros, see HAL Security programming guides and tutorials.
+ */
+
+ #endif /* __TIZEN_HAL_SECURITY_CERTS_DOC_H__ */
\ No newline at end of file
diff --git a/doc/hal_security_doc.h b/doc/hal_security_doc.h
new file mode 100644
index 0000000..277f695
--- /dev/null
+++ b/doc/hal_security_doc.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2025 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+
+#ifndef __TIZEN_HAL_SECURITY_DOC_H__
+#define __TIZEN_HAL_SECURITY_DOC_H__
+
+
+/**
+ * @file hal_security_doc.h
+ * @brief This file contains high level documentation of the HAL Security.
+ */
+
+/**
+ * @defgroup HALAPI_HAL_SECURITY Security
+ * @brief  The SECURITY module provides functions to handle cryptography operations.
+ * @section HALAPI_HAL_SECURITY_OVERVIEW Overview
+ * <table>
+ * <tr>
+ *    <th>Module</th>
+ *    <th>Description</th>
+ * </tr>
+ * <tr>
+ *    <td>@ref HALAPI_HAL_SECURITY_CERTS_MODULE</td>
+ *    <td>Provides functions to handle device certificates and signing operations</td>
+ * </tr>
+ * </table>
+ *
+ * For more information on the HAL Security submodule features, see HAL Security Guide.
+ */
+
+#endif /* __TIZEN_HAL_SECURITY_DOC_H__ */