ON Semiconductor / mbed-os

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

targets/TARGET_Maxim/TARGET_MAX32625/mxc/maa.h@0:098463de4c5d, 2017-01-25 (annotated)

Committer:
group-onsemi
Date:
Wed Jan 25 20:34:15 2017 +0000
Revision:
0:098463de4c5d
Initial commit

Who changed what in which revision?

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