include/crypto/kirk.h: Added doxygen support.

This commit is contained in:
Felix-Dev 2016-08-03 02:32:07 +02:00
parent 8014c89e26
commit 924c3e3ec4
3 changed files with 56 additions and 41 deletions

View File

@ -2,6 +2,18 @@
See the file COPYING for copying permission.
*/
/** @defgroup KIRK KIRK
* The hardware crypto engine responsible for almost all aspects of the PSPs security, \n
* including decryption of EBOOTs & PRXs, savefile and adhoc encryption, and idstorage verification.
*/
/**
* @defgroup Crypto
* @ingroup KIRK
*
* @{
*/
#ifndef KIRK_H
#define KIRK_H
@ -52,4 +64,7 @@ typedef struct {
SceSize dataSize;
} KirkAESHeader;
#endif /* KIRK_H */
#endif /* KIRK_H */
/** @} */

View File

@ -1,41 +1,41 @@
/* Copyright (C) 2011 - 2015 The uOFW team
See the file COPYING for copying permission.
*/
/* Copyright (C) 2011 - 2015 The uOFW team
See the file COPYING for copying permission.
*/
/**
* @defgroup DNAS_ERROR DNAS Errors
* @defgroup DNAS_ERROR DNAS Errors
* @ingroup DNAS
*
* uofw/include/dnas_error.h \n
*
* uofw/include/dnas_error.h \n
*
* Defines error codes specifically for the DNAS facility. \n
*
* @{
*/
#ifndef DNAS_ERROR_H
#define DNAS_ERROR_H
#include "common_header.h"
#ifdef __cplusplus
extern "C" {
#endif
/*
DNAS error codes
SCE_ERROR_FACILITY_DNAS = 0x053
*/
#define SCE_DNAS_ERROR_OPERATION_FAILED 0x80530300 /** The requested operation failed. */
#define SCE_DNAS_ERROR_INVALID_ARGUMENTS 0x80530301 /** The provided arguments are not correct. */
#ifdef __cplusplus
}
#endif
#endif /* DNAS_ERROR_H */
/** @} */
*/
#ifndef DNAS_ERROR_H
#define DNAS_ERROR_H
#include "common_header.h"
#ifdef __cplusplus
extern "C" {
#endif
/*
DNAS error codes
SCE_ERROR_FACILITY_DNAS = 0x053
*/
#define SCE_DNAS_ERROR_OPERATION_FAILED 0x80530300 /** The requested operation failed. */
#define SCE_DNAS_ERROR_INVALID_ARGUMENTS 0x80530301 /** The provided arguments are not correct. */
#ifdef __cplusplus
}
#endif
#endif /* DNAS_ERROR_H */
/** @} */

View File

@ -2,13 +2,13 @@
See the file COPYING for copying permission.
*/
/** @defgroup DNAS Dynamic Network Authentication System
* An authentication system used for online authentication \n
* (for example with a game server).
/** @defgroup DNAS Dynamic Network Authentication System
* An authentication system used for online authentication \n
* (for example with a game server).
*/
/**
* @defgroup OpenPSID OpenPSID
* @defgroup OpenPSID OpenPSID
* @ingroup DNAS
*
* @{
@ -58,7 +58,7 @@ extern "C" {
* Generate a SHA-1 hash value of the provided data.
*
* @param pSrcData Pointer to data to generate the hash for.
* @param size The size of the source data. Max size: SCE_DNAS_USER_DATA_MAX_LEN byte.
* @param size The size of the source data. Max size: ::SCE_DNAS_USER_DATA_MAX_LEN byte.
* @param pDigest Pointer to buffer receiving the hash. Size: ::KIRK_SHA1_DIGEST_LEN.
*
* @return 0 on success, otherwise < 0.