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