mimxrt1180_crypto_trng.c
Go to the documentation of this file.
1 /**
2  * @file mimxrt1180_crypto_trng.c
3  * @brief i.MX RT1180 true random number generator
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.5.4
29  **/
30 
31 //Switch to the appropriate trace level
32 #define TRACE_LEVEL CRYPTO_TRACE_LEVEL
33 
34 //Dependencies
35 #include "fsl_device_registers.h"
36 #include "ele_crypto.h"
37 #include "core/crypto.h"
40 #include "debug.h"
41 
42 //Check crypto library configuration
43 #if (MIMXRT1180_CRYPTO_TRNG_SUPPORT == ENABLED)
44 
45 
46 /**
47  * @brief TRNG module initialization
48  * @return Error code
49  **/
50 
52 {
53  status_t status;
54  uint32_t state;
55 
56  //Initialize TRNG context
57  status = ELE_StartRng(MU_APPS_S3MUA);
58 
59  //Check status code
60  if(status == kStatus_Success)
61  {
62  //Wait for the TRNG to be ready for use
63  do
64  {
65  //Get TRNG state
66  status = ELE_GetTrngState(MU_APPS_S3MUA, &state);
67 
68  //Check TRNG state
69  } while(status == kStatus_Success && (state & 0xFF) != kELE_TRNG_ready);
70  }
71 
72  //Return status code
73  return (status == kStatus_Success) ? NO_ERROR : ERROR_FAILURE;
74 }
75 
76 
77 /**
78  * @brief Get random data from the TRNG module
79  * @param[out] data Buffer where to store random data
80  * @param[in] length Number of random bytes to generate
81  **/
82 
84 {
85  size_t i;
86  uint32_t value;
87  status_t status;
88 
89  //Initialize status code
90  status = kStatus_Success;
91 
92  //Acquire exclusive access to the ELE module
94 
95  //Generate random data
96  for(i = 0; i < length; i++)
97  {
98  //Generate a new 32-bit random value when necessary
99  if((i % 4) == 0)
100  {
101  //Get 32-bit random value
102  status = ELE_RngGetRandom(MU_APPS_S3MUA, &value, 4, kNoReseed);
103  //Check status code
104  if(status != kStatus_Success)
105  {
106  break;
107  }
108  }
109 
110  //Copy random byte
111  data[i] = value & 0xFF;
112  //Shift the 32-bit random value
113  value >>= 8;
114  }
115 
116  //Release exclusive access to the ELE module
118 
119  //Return status code
120  return (status == kStatus_Success) ? NO_ERROR : ERROR_FAILURE;
121 }
122 
123 #endif
uint8_t data[]
Definition: ethernet.h:224
error_t
Error codes.
Definition: error.h:43
error_t trngGetRandomData(uint8_t *data, size_t length)
Get random data from the TRNG module.
@ ERROR_FAILURE
Generic error code.
Definition: error.h:45
i.MX RT1180 true random number generator
General definitions for cryptographic algorithms.
OsMutex mimxrt1180CryptoMutex
uint8_t length
Definition: tcp.h:375
void osAcquireMutex(OsMutex *mutex)
Acquire ownership of the specified mutex object.
void osReleaseMutex(OsMutex *mutex)
Release ownership of the specified mutex object.
i.MX RT1180 hardware cryptographic accelerator (ELE)
error_t trngInit(void)
TRNG module initialization.
uint8_t value[]
Definition: tcp.h:376
@ NO_ERROR
Success.
Definition: error.h:44
Debugging facilities.