1 /****************************************************************************** 2 * Filename: sha2_doc.h 3 * 4 * Copyright (c) 2015 - 2022, Texas Instruments Incorporated 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions are met: 9 * 10 * 1) Redistributions of source code must retain the above copyright notice, 11 * this list of conditions and the following disclaimer. 12 * 13 * 2) Redistributions in binary form must reproduce the above copyright notice, 14 * this list of conditions and the following disclaimer in the documentation 15 * and/or other materials provided with the distribution. 16 * 17 * 3) Neither the name of the ORGANIZATION nor the names of its contributors may 18 * be used to endorse or promote products derived from this software without 19 * specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 22 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 25 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 31 * POSSIBILITY OF SUCH DAMAGE. 32 * 33 ******************************************************************************/ 34 //! \addtogroup sha2_api 35 //! @{ 36 //! \section sec_sha2 Introduction 37 //! 38 //! The SHA-2 (Secure Hash Algorithm) API provides access to the SHA-2 39 //! functionality of the crypto core. The AES accelerator and keystore are 40 //! also contained within the crypto core. Hence, only one of SHA-2 and AES 41 //! may be used at the same time. 42 //! This module offers hardware acceleration for the SHA-2 family of hash 43 //! algorithms. The following output digest sizes are supported: 44 //! - 224 bits 45 //! - 256 bits 46 //! - 384 bits 47 //! - 512 bits 48 //! 49 //! Messages are hashed in one go or in multiple steps. Stepwise hashing 50 //! consists of an initial hash, multiple intermediate hashes, and a 51 //! finalization hash. 52 //! 53 //! The crypto core does not have retention and all configuration settings 54 //! are lost when going into standby or shutdown. If you wish to continue 55 //! a hash operation after going into standby or shutdown, you must load 56 //! the intermediate hash into system RAM before entering standby or shutdown 57 //! and load the intermediate hash back into the crypto module after resuming 58 //! operation. 59 //! 60 //! @} 61
