mirror of
				https://github.com/cuberite/polarssl.git
				synced 2025-11-03 20:22:59 -05:00 
			
		
		
		
	Add notes about the purpose and usage of auxiliary header files
This commit is contained in:
		
							parent
							
								
									0b352bcf95
								
							
						
					
					
						commit
						07c91f5df3
					
				@ -2,6 +2,11 @@
 | 
			
		||||
 * \file psa/crypto_extra.h
 | 
			
		||||
 *
 | 
			
		||||
 * \brief PSA cryptography module: Mbed TLS vendor extensions
 | 
			
		||||
 *
 | 
			
		||||
 * \note This file may not be included directly. Applications must
 | 
			
		||||
 * include psa/crypto.h.
 | 
			
		||||
 *
 | 
			
		||||
 * This file is reserved for vendor-specific definitions.
 | 
			
		||||
 */
 | 
			
		||||
/*
 | 
			
		||||
 *  Copyright (C) 2018, ARM Limited, All Rights Reserved
 | 
			
		||||
 | 
			
		||||
@ -2,6 +2,16 @@
 | 
			
		||||
 * \file psa/crypto_platform.h
 | 
			
		||||
 *
 | 
			
		||||
 * \brief PSA cryptography module: Mbed TLS platfom definitions
 | 
			
		||||
 *
 | 
			
		||||
 * \note This file may not be included directly. Applications must
 | 
			
		||||
 * include psa/crypto.h.
 | 
			
		||||
 *
 | 
			
		||||
 * This file contains platform-dependent type definitions.
 | 
			
		||||
 *
 | 
			
		||||
 * In implementations with isolation between the application and the
 | 
			
		||||
 * cryptography module, implementers should take care to ensure that
 | 
			
		||||
 * the definitions that are exposed to applications match what the
 | 
			
		||||
 * module implements.
 | 
			
		||||
 */
 | 
			
		||||
/*
 | 
			
		||||
 *  Copyright (C) 2018, ARM Limited, All Rights Reserved
 | 
			
		||||
 | 
			
		||||
@ -3,12 +3,20 @@
 | 
			
		||||
 *
 | 
			
		||||
 * \brief PSA cryptography module: Mbed TLS buffer size macros
 | 
			
		||||
 *
 | 
			
		||||
 * \note This file may not be included directly. Applications must
 | 
			
		||||
 * include psa/crypto.h.
 | 
			
		||||
 *
 | 
			
		||||
 * This file contains the definitions of macros that are useful to
 | 
			
		||||
 * compute buffer sizes. The signatures and semantics of these macros
 | 
			
		||||
 * are standardized, but the definitions are not, because they depend on
 | 
			
		||||
 * the available algorithms and, in some cases, on permitted tolerances
 | 
			
		||||
 * on buffer sizes.
 | 
			
		||||
 *
 | 
			
		||||
 * In implementations with isolation between the application and the
 | 
			
		||||
 * cryptography module, implementers should take care to ensure that
 | 
			
		||||
 * the definitions that are exposed to applications match what the
 | 
			
		||||
 * module implements.
 | 
			
		||||
 *
 | 
			
		||||
 * Macros that compute sizes whose values do not depend on the
 | 
			
		||||
 * implementation are in crypto.h.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
@ -2,6 +2,16 @@
 | 
			
		||||
 * \file psa/crypto_struct.h
 | 
			
		||||
 *
 | 
			
		||||
 * \brief PSA cryptography module: Mbed TLS structured type implementations
 | 
			
		||||
 *
 | 
			
		||||
 * \note This file may not be included directly. Applications must
 | 
			
		||||
 * include psa/crypto.h.
 | 
			
		||||
 *
 | 
			
		||||
 * This file contains the definitions of some data structures with
 | 
			
		||||
 * implementation-specific definitions.
 | 
			
		||||
 *
 | 
			
		||||
 * In implementations with isolation between the application and the
 | 
			
		||||
 * cryptography module, it is expected that the front-end and the back-end
 | 
			
		||||
 * would have different versions of this file.
 | 
			
		||||
 */
 | 
			
		||||
/*
 | 
			
		||||
 *  Copyright (C) 2018, ARM Limited, All Rights Reserved
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user