mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/mxc/maa.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
186:707f6e361f3e 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 186:707f6e361f3e 1 /**
Anna Bridge 186:707f6e361f3e 2 * @file
Anna Bridge 186:707f6e361f3e 3 * @brief Registers, Bit Masks and Bit Positions for the Modular Math
Anna Bridge 186:707f6e361f3e 4 * Accelerator (MAA) module.
Anna Bridge 186:707f6e361f3e 5 */
Anna Bridge 186:707f6e361f3e 6 /* *****************************************************************************
Anna Bridge 186:707f6e361f3e 7 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Anna Bridge 186:707f6e361f3e 8 *
Anna Bridge 186:707f6e361f3e 9 * Permission is hereby granted, free of charge, to any person obtaining a
Anna Bridge 186:707f6e361f3e 10 * copy of this software and associated documentation files (the "Software"),
Anna Bridge 186:707f6e361f3e 11 * to deal in the Software without restriction, including without limitation
Anna Bridge 186:707f6e361f3e 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Anna Bridge 186:707f6e361f3e 13 * and/or sell copies of the Software, and to permit persons to whom the
Anna Bridge 186:707f6e361f3e 14 * Software is furnished to do so, subject to the following conditions:
Anna Bridge 186:707f6e361f3e 15 *
Anna Bridge 186:707f6e361f3e 16 * The above copyright notice and this permission notice shall be included
Anna Bridge 186:707f6e361f3e 17 * in all copies or substantial portions of the Software.
Anna Bridge 186:707f6e361f3e 18 *
Anna Bridge 186:707f6e361f3e 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Anna Bridge 186:707f6e361f3e 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Anna Bridge 186:707f6e361f3e 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Anna Bridge 186:707f6e361f3e 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Anna Bridge 186:707f6e361f3e 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Anna Bridge 186:707f6e361f3e 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Anna Bridge 186:707f6e361f3e 25 * OTHER DEALINGS IN THE SOFTWARE.
Anna Bridge 186:707f6e361f3e 26 *
Anna Bridge 186:707f6e361f3e 27 * Except as contained in this notice, the name of Maxim Integrated
Anna Bridge 186:707f6e361f3e 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Anna Bridge 186:707f6e361f3e 29 * Products, Inc. Branding Policy.
Anna Bridge 186:707f6e361f3e 30 *
Anna Bridge 186:707f6e361f3e 31 * The mere transfer of this software does not imply any licenses
Anna Bridge 186:707f6e361f3e 32 * of trade secrets, proprietary technology, copyrights, patents,
Anna Bridge 186:707f6e361f3e 33 * trademarks, maskwork rights, or any other form of intellectual
Anna Bridge 186:707f6e361f3e 34 * property whatsoever. Maxim Integrated Products, Inc. retains all
Anna Bridge 186:707f6e361f3e 35 * ownership rights.
Anna Bridge 186:707f6e361f3e 36 *
Anna Bridge 186:707f6e361f3e 37 * $Date: 2017-02-16 12:05:53 -0600 (Thu, 16 Feb 2017) $
Anna Bridge 186:707f6e361f3e 38 * $Revision: 26466 $
Anna Bridge 186:707f6e361f3e 39 *
Anna Bridge 186:707f6e361f3e 40 **************************************************************************** */
Anna Bridge 186:707f6e361f3e 41
Anna Bridge 186:707f6e361f3e 42 /* Define to prevent redundant inclusion */
Anna Bridge 186:707f6e361f3e 43 #ifndef _MAA_H
Anna Bridge 186:707f6e361f3e 44 #define _MAA_H
Anna Bridge 186:707f6e361f3e 45
Anna Bridge 186:707f6e361f3e 46 /* **** Includes **** */
Anna Bridge 186:707f6e361f3e 47 #include <stdint.h>
Anna Bridge 186:707f6e361f3e 48 /**
Anna Bridge 186:707f6e361f3e 49 * @defgroup maa MAA
Anna Bridge 186:707f6e361f3e 50 * @ingroup periphlibs
Anna Bridge 186:707f6e361f3e 51 * @details The API only supports synchronous operations due to the sensitive
Anna Bridge 186:707f6e361f3e 52 * nature of the input and output data.
Anna Bridge 186:707f6e361f3e 53 * @{
Anna Bridge 186:707f6e361f3e 54 */
Anna Bridge 186:707f6e361f3e 55 #include "maa_regs.h"
Anna Bridge 186:707f6e361f3e 56
Anna Bridge 186:707f6e361f3e 57 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 58 extern "C" {
Anna Bridge 186:707f6e361f3e 59 #endif
Anna Bridge 186:707f6e361f3e 60
Anna Bridge 186:707f6e361f3e 61
Anna Bridge 186:707f6e361f3e 62
Anna Bridge 186:707f6e361f3e 63 /* **** Definitions **** */
Anna Bridge 186:707f6e361f3e 64
Anna Bridge 186:707f6e361f3e 65 /**
Anna Bridge 186:707f6e361f3e 66 * Definition for the maximum MAA register size on this device in bytes, 128.
Anna Bridge 186:707f6e361f3e 67 */
Anna Bridge 186:707f6e361f3e 68 #define MXC_MAA_REG_SIZE 0x80
Anna Bridge 186:707f6e361f3e 69 /**
Anna Bridge 186:707f6e361f3e 70 * Definition for the maximum MAA register size on this device in bits, 1024.
Anna Bridge 186:707f6e361f3e 71 */
Anna Bridge 186:707f6e361f3e 72 #define MXC_MAA_REG_SIZE_BITS (MXC_MAA_REG_SIZE << 3)
Anna Bridge 186:707f6e361f3e 73
Anna Bridge 186:707f6e361f3e 74 /**
Anna Bridge 186:707f6e361f3e 75 * Definition for a sub-register ("half size"), allowing 2x more operands in MAA at a time when \f$ MAWS \leq \fraq{MAX\_SIZE}{2} \f$
Anna Bridge 186:707f6e361f3e 76 */
Anna Bridge 186:707f6e361f3e 77 #define MXC_MAA_HALF_SIZE (MXC_MAA_REG_SIZE/2)
Anna Bridge 186:707f6e361f3e 78
Anna Bridge 186:707f6e361f3e 79 /** Flags for MAA_Load() and MAA_Unload() */
Anna Bridge 186:707f6e361f3e 80 #define MXC_MAA_F_MEM_VERBATIM 0
Anna Bridge 186:707f6e361f3e 81 /** Flags for MAA_Load() and MAA_Unload() */
Anna Bridge 186:707f6e361f3e 82 #define MXC_MAA_F_MEM_REVERSE 1
Anna Bridge 186:707f6e361f3e 83
Anna Bridge 186:707f6e361f3e 84 /**
Anna Bridge 186:707f6e361f3e 85 * Enumeration type for Segment and Sub-segment selection
Anna Bridge 186:707f6e361f3e 86 */
Anna Bridge 186:707f6e361f3e 87 typedef enum {
Anna Bridge 186:707f6e361f3e 88 /* Warning: Do not change the assigned numbers/ordering without associated changes to UMAA_REGFILE_TO_ADDR(x) */
Anna Bridge 186:707f6e361f3e 89 /* Register names when MAWS > 512 */
Anna Bridge 186:707f6e361f3e 90 MXC_E_REG_0 = 0, /**< Register MXC_E_REG_0: If MAA_MAWS > 512 use this register name. */
Anna Bridge 186:707f6e361f3e 91 MXC_E_REG_1 = 2, /**< Register MXC_E_REG_1: If MAA_MAWS > 512 use this register name. */
Anna Bridge 186:707f6e361f3e 92 MXC_E_REG_2 = 4, /**< Register MXC_E_REG_2: If MAA_MAWS > 512 use this register name. */
Anna Bridge 186:707f6e361f3e 93 MXC_E_REG_3 = 6, /**< Register MXC_E_REG_3: If MAA_MAWS > 512 use this register name. */
Anna Bridge 186:707f6e361f3e 94 MXC_E_REG_4 = 8, /**< Register MXC_E_REG_4: If MAA_MAWS > 512 use this register name. */
Anna Bridge 186:707f6e361f3e 95 MXC_E_REG_5 = 10, /**< Register MXC_E_REG_5: If MAA_MAWS > 512 use this register name. */
Anna Bridge 186:707f6e361f3e 96 /* Register names when MAWS < 512 */
Anna Bridge 186:707f6e361f3e 97 MXC_E_REG_00 = 0, /**< Register MXC_E_REG_00: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 98 MXC_E_REG_01 = 1, /**< Register MXC_E_REG_01: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 99 MXC_E_REG_10 = 2, /**< Register MXC_E_REG_10: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 100 MXC_E_REG_11 = 3, /**< Register MXC_E_REG_11: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 101 MXC_E_REG_20 = 4, /**< Register MXC_E_REG_20: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 102 MXC_E_REG_21 = 5, /**< Register MXC_E_REG_21: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 103 MXC_E_REG_30 = 6, /**< Register MXC_E_REG_30: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 104 MXC_E_REG_31 = 7, /**< Register MXC_E_REG_31: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 105 MXC_E_REG_40 = 8, /**< Register MXC_E_REG_40: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 106 MXC_E_REG_41 = 9, /**< Register MXC_E_REG_41: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 107 MXC_E_REG_50 = 10, /**< Register MXC_E_REG_50: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 108 MXC_E_REG_51 = 11 /**< Register MXC_E_REG_51: If MAA_MAWS < 512 this is the register name. */
Anna Bridge 186:707f6e361f3e 109 } mxc_maa_reg_select_t;
Anna Bridge 186:707f6e361f3e 110
Anna Bridge 186:707f6e361f3e 111 /**
Anna Bridge 186:707f6e361f3e 112 * Enumeration type for MAA operation selection.
Anna Bridge 186:707f6e361f3e 113 */
Anna Bridge 186:707f6e361f3e 114 typedef enum {
Anna Bridge 186:707f6e361f3e 115 MXC_E_MAA_EXP = 0, /**< Exponentiate */
Anna Bridge 186:707f6e361f3e 116 MXC_E_MAA_SQR = 1, /**< Square */
Anna Bridge 186:707f6e361f3e 117 MXC_E_MAA_MUL = 2, /**< Multiply */
Anna Bridge 186:707f6e361f3e 118 MXC_E_MAA_SQRMUL = 3, /**< Square followed by Multiply */
Anna Bridge 186:707f6e361f3e 119 MXC_E_MAA_ADD = 4, /**< Addition */
Anna Bridge 186:707f6e361f3e 120 MXC_E_MAA_SUB = 5 /**< Subtraction */
Anna Bridge 186:707f6e361f3e 121 } mxc_maa_operation_t;
Anna Bridge 186:707f6e361f3e 122
Anna Bridge 186:707f6e361f3e 123 /**
Anna Bridge 186:707f6e361f3e 124 * Enumeration type to set special flags for loading & unloading data.
Anna Bridge 186:707f6e361f3e 125 */
Anna Bridge 186:707f6e361f3e 126 typedef enum {
Anna Bridge 186:707f6e361f3e 127
Anna Bridge 186:707f6e361f3e 128 MXC_E_MAA_VERBATIM = 0, /**< Copy bytes without reversal and right-justification */
Anna Bridge 186:707f6e361f3e 129 MXC_E_MAA_REVERSE /**< Reverse bytes and right-justify (bytes are loaded at the highest address, then descending) */
Anna Bridge 186:707f6e361f3e 130 } mxc_maa_endian_select_t;
Anna Bridge 186:707f6e361f3e 131
Anna Bridge 186:707f6e361f3e 132 /**
Anna Bridge 186:707f6e361f3e 133 * Enumeration type for MAA module specific return codes.
Anna Bridge 186:707f6e361f3e 134 */
Anna Bridge 186:707f6e361f3e 135 typedef enum {
Anna Bridge 186:707f6e361f3e 136 MXC_E_MAA_ERR = -1, /**< Error */
Anna Bridge 186:707f6e361f3e 137 MXC_E_MAA_OK = 0, /**< No Error */
Anna Bridge 186:707f6e361f3e 138 MXC_E_MAA_BUSY /**< MAA engine busy, try again later */
Anna Bridge 186:707f6e361f3e 139 } mxc_maa_ret_t;
Anna Bridge 186:707f6e361f3e 140
Anna Bridge 186:707f6e361f3e 141 /**
Anna Bridge 186:707f6e361f3e 142 * @brief Initialize the required clocks and enable the MAA peripheral
Anna Bridge 186:707f6e361f3e 143 * module.
Anna Bridge 186:707f6e361f3e 144 * @retval #MXC_E_MAA_ERR on error.
Anna Bridge 186:707f6e361f3e 145 * @retval #MXC_E_MAA_BUSY if the MAA is busy.
Anna Bridge 186:707f6e361f3e 146 * @retval #MXC_E_MAA_OK if the MAA is initialized successfully.
Anna Bridge 186:707f6e361f3e 147 */
Anna Bridge 186:707f6e361f3e 148 mxc_maa_ret_t MAA_Init(void);
Anna Bridge 186:707f6e361f3e 149
Anna Bridge 186:707f6e361f3e 150 /**
Anna Bridge 186:707f6e361f3e 151 * @brief Erase all MAA register RAM
Anna Bridge 186:707f6e361f3e 152 * @retval #MXC_E_MAA_ERR on error.
Anna Bridge 186:707f6e361f3e 153 * @retval #MXC_E_MAA_BUSY if the MAA is busy.
Anna Bridge 186:707f6e361f3e 154 * @retval #MXC_E_MAA_OK if the MAA is initialized successfully.
Anna Bridge 186:707f6e361f3e 155 */
Anna Bridge 186:707f6e361f3e 156 mxc_maa_ret_t MAA_WipeRAM(void);
Anna Bridge 186:707f6e361f3e 157
Anna Bridge 186:707f6e361f3e 158
Anna Bridge 186:707f6e361f3e 159 /**
Anna Bridge 186:707f6e361f3e 160 * @brief Load the selected MAA register.
Anna Bridge 186:707f6e361f3e 161 *
Anna Bridge 186:707f6e361f3e 162 * @param regfile Selects the register to load.
Anna Bridge 186:707f6e361f3e 163 * @param data Pointer to a data buffer to load into the register.
Anna Bridge 186:707f6e361f3e 164 * @param size Size of the data to load.
Anna Bridge 186:707f6e361f3e 165 * @param flag Reverse the data so that it will unload properly on
Anna Bridge 186:707f6e361f3e 166 * little endian machines, see #mxc_maa_endian_select_t.
Anna Bridge 186:707f6e361f3e 167 *
Anna Bridge 186:707f6e361f3e 168 * @return #MXC_E_MAA_ERR if any parameter out of range.
Anna Bridge 186:707f6e361f3e 169 * @return #MXC_E_MAA_BUSY if MAA registers are not currently accessible.
Anna Bridge 186:707f6e361f3e 170 * @return #MXC_E_MAA_OK if the selected register is loaded correctly.
Anna Bridge 186:707f6e361f3e 171 */
Anna Bridge 186:707f6e361f3e 172 mxc_maa_ret_t MAA_Load(mxc_maa_reg_select_t regfile, const uint8_t *data, unsigned int size, mxc_maa_endian_select_t flag);
Anna Bridge 186:707f6e361f3e 173
Anna Bridge 186:707f6e361f3e 174 /**
Anna Bridge 186:707f6e361f3e 175 * @brief Unload (copy from) the selected MAA register
Anna Bridge 186:707f6e361f3e 176 *
Anna Bridge 186:707f6e361f3e 177 * @param regfile Selects the register to unload.
Anna Bridge 186:707f6e361f3e 178 * @param data Pointer to a buffer to store the unloaded data.
Anna Bridge 186:707f6e361f3e 179 * @param size Maximum size of the data to unload.
Anna Bridge 186:707f6e361f3e 180 * @param flag Reverse the data so that it will unload properly on
Anna Bridge 186:707f6e361f3e 181 * little endian machines, see #mxc_maa_endian_select_t.
Anna Bridge 186:707f6e361f3e 182 * @return #MXC_E_MAA_ERR if any parameter out of range.
Anna Bridge 186:707f6e361f3e 183 * @return #MXC_E_MAA_BUSY if MAA registers are not currently accessible.
Anna Bridge 186:707f6e361f3e 184 * @return #MXC_E_MAA_OK if the requested register data is copied correctly
Anna Bridge 186:707f6e361f3e 185 * to @p data.
Anna Bridge 186:707f6e361f3e 186 */
Anna Bridge 186:707f6e361f3e 187 mxc_maa_ret_t MAA_Unload(mxc_maa_reg_select_t regfile, uint8_t *data, unsigned int size, mxc_maa_endian_select_t flag);
Anna Bridge 186:707f6e361f3e 188
Anna Bridge 186:707f6e361f3e 189 /**
Anna Bridge 186:707f6e361f3e 190 * @brief Execute an MAA operation specified.
Anna Bridge 186:707f6e361f3e 191 *
Anna Bridge 186:707f6e361f3e 192 * @param op Operation to perform, see #mxc_maa_operation_t.
Anna Bridge 186:707f6e361f3e 193 * @param al Segment to use for operand A, see #mxc_maa_reg_select_t.
Anna Bridge 186:707f6e361f3e 194 * @param bl Segment to use for operand B.
Anna Bridge 186:707f6e361f3e 195 * @param rl Segment which will hold result R after the operation is
Anna Bridge 186:707f6e361f3e 196 * complete.
Anna Bridge 186:707f6e361f3e 197 * @param tl Segment to use for temporary storage T.
Anna Bridge 186:707f6e361f3e 198 *
Anna Bridge 186:707f6e361f3e 199 * @return #MXC_E_MAA_ERR if any parameter out of range.
Anna Bridge 186:707f6e361f3e 200 * @return #MXC_E_MAA_BUSY if MAA registers are not currently accessible.
Anna Bridge 186:707f6e361f3e 201 * @return #MXC_E_MAA_OK if the operation completed.
Anna Bridge 186:707f6e361f3e 202 */
Anna Bridge 186:707f6e361f3e 203 mxc_maa_ret_t MAA_Run(mxc_maa_operation_t op, \
Anna Bridge 186:707f6e361f3e 204 mxc_maa_reg_select_t al, mxc_maa_reg_select_t bl, \
Anna Bridge 186:707f6e361f3e 205 mxc_maa_reg_select_t rl, mxc_maa_reg_select_t tl);
Anna Bridge 186:707f6e361f3e 206
Anna Bridge 186:707f6e361f3e 207 /**
Anna Bridge 186:707f6e361f3e 208 * @brief Set the bit length of the modulus.
Anna Bridge 186:707f6e361f3e 209 *
Anna Bridge 186:707f6e361f3e 210 * @param len Modulus size in bits (ie. \f$ ln_2(modulus) \f$ )
Anna Bridge 186:707f6e361f3e 211 *
Anna Bridge 186:707f6e361f3e 212 * @return #MXC_E_MAA_ERR if any parameter out of range.
Anna Bridge 186:707f6e361f3e 213 * @return #MXC_E_MAA_BUSY if MAA registers are not currently accessible.
Anna Bridge 186:707f6e361f3e 214 * @return #MXC_E_MAA_OK if the length is set as requested.
Anna Bridge 186:707f6e361f3e 215 */
Anna Bridge 186:707f6e361f3e 216 mxc_maa_ret_t MAA_SetWordSize(unsigned int len);
Anna Bridge 186:707f6e361f3e 217
Anna Bridge 186:707f6e361f3e 218 /**@} end of group maa*/
Anna Bridge 186:707f6e361f3e 219
Anna Bridge 186:707f6e361f3e 220 #ifdef __cplusplus
Anna Bridge 186:707f6e361f3e 221 }
Anna Bridge 186:707f6e361f3e 222 #endif
Anna Bridge 186:707f6e361f3e 223
Anna Bridge 186:707f6e361f3e 224 #endif