bsp/socal/alt_dmasecure.h

0001 /**
0002  * @file
0003  *
0004  * @ingroup RTEMSBSPsARMCycVContrib
0005  */
0006
0007 /*******************************************************************************
0008 *                                                                              *
0009 * Copyright 2013 Altera Corporation. All Rights Reserved.                      *
0010 *                                                                              *
0011 * Redistribution and use in source and binary forms, with or without           *
0012 * modification, are permitted provided that the following conditions are met:  *
0013 *                                                                              *
0014 * 1. Redistributions of source code must retain the above copyright notice,    *
0015 *    this list of conditions and the following disclaimer.                     *
0016 *                                                                              *
0017 * 2. Redistributions in binary form must reproduce the above copyright notice, *
0018 *    this list of conditions and the following disclaimer in the documentation *
0019 *    and/or other materials provided with the distribution.                    *
0020 *                                                                              *
0021 * 3. The name of the author may not be used to endorse or promote products     *
0022 *    derived from this software without specific prior written permission.     *
0023 *                                                                              *
0024 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY EXPRESS OR *
0025 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF *
0026 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED. IN NO  *
0027 * EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,       *
0028 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
0029 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;  *
0030 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,     *
0031 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR      *
0032 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF       *
0033 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                                   *
0034 *                                                                              *
0035 *******************************************************************************/
0036
0037 /* Altera - ALT_DMASECURE */
0038
0039 #ifndef __ALTERA_ALT_DMASECURE_H__
0040 #define __ALTERA_ALT_DMASECURE_H__
0041
0042 #ifdef __cplusplus
0043 extern "C"
0044 {
0045 #endif  /* __cplusplus */
0046
0047 /*
0048  * Component : secure DMA Module Address Space - ALT_DMASECURE
0049  * secure DMA Module Address Space
0050  *
0051  * Address space allocated to the secure DMA. For detailed information about the
0052  * use of this address space,
0053  * [url=http://infocenter.arm.com/help/topic/com.arm.doc.ddi0424b/index.html]click
0054  * here[/url] to access the ARM documentation for the DMA-330.
0055  *
0056  */
0057 /*
0058  * Register : Empty - reg
0059  *
0060  * Placeholder
0061  *
0062  * Register Layout
0063  *
0064  *  Bits   | Access | Reset   | Description
0065  * :-------|:-------|:--------|:------------
0066  *  [31:0] | RW     | Unknown | Empty
0067  *
0068  */
0069 /*
0070  * Field : Empty - fld
0071  *
0072  * Placeholder
0073  *
0074  * Field Access Macros:
0075  *
0076  */
0077 /* The Least Significant Bit (LSB) position of the ALT_DMASECURE_REG_FLD register field. */
0078 #define ALT_DMASECURE_REG_FLD_LSB        0
0079 /* The Most Significant Bit (MSB) position of the ALT_DMASECURE_REG_FLD register field. */
0080 #define ALT_DMASECURE_REG_FLD_MSB        31
0081 /* The width in bits of the ALT_DMASECURE_REG_FLD register field. */
0082 #define ALT_DMASECURE_REG_FLD_WIDTH      32
0083 /* The mask used to set the ALT_DMASECURE_REG_FLD register field value. */
0084 #define ALT_DMASECURE_REG_FLD_SET_MSK    0xffffffff
0085 /* The mask used to clear the ALT_DMASECURE_REG_FLD register field value. */
0086 #define ALT_DMASECURE_REG_FLD_CLR_MSK    0x00000000
0087 /* The reset value of the ALT_DMASECURE_REG_FLD register field is UNKNOWN. */
0088 #define ALT_DMASECURE_REG_FLD_RESET      0x0
0089 /* Extracts the ALT_DMASECURE_REG_FLD field value from a register. */
0090 #define ALT_DMASECURE_REG_FLD_GET(value) (((value) & 0xffffffff) >> 0)
0091 /* Produces a ALT_DMASECURE_REG_FLD register field value suitable for setting the register. */
0092 #define ALT_DMASECURE_REG_FLD_SET(value) (((value) << 0) & 0xffffffff)
0093
0094 #ifndef __ASSEMBLY__
0095 /*
0096  * WARNING: The C register and register group struct declarations are provided for
0097  * convenience and illustrative purposes. They should, however, be used with
0098  * caution as the C language standard provides no guarantees about the alignment or
0099  * atomicity of device memory accesses. The recommended practice for writing
0100  * hardware drivers is to use the SoCAL access macros and alt_read_word() and
0101  * alt_write_word() functions.
0102  *
0103  * The struct declaration for register ALT_DMASECURE_REG.
0104  */
0105 struct ALT_DMASECURE_REG_s
0106 {
0107     uint32_t  fld : 32;  /* Empty */
0108 };
0109
0110 /* The typedef declaration for register ALT_DMASECURE_REG. */
0111 typedef volatile struct ALT_DMASECURE_REG_s  ALT_DMASECURE_REG_t;
0112 #endif  /* __ASSEMBLY__ */
0113
0114 /* The byte offset of the ALT_DMASECURE_REG register from the beginning of the component. */
0115 #define ALT_DMASECURE_REG_OFST        0x0
0116
0117 #ifndef __ASSEMBLY__
0118 /*
0119  * WARNING: The C register and register group struct declarations are provided for
0120  * convenience and illustrative purposes. They should, however, be used with
0121  * caution as the C language standard provides no guarantees about the alignment or
0122  * atomicity of device memory accesses. The recommended practice for writing
0123  * hardware drivers is to use the SoCAL access macros and alt_read_word() and
0124  * alt_write_word() functions.
0125  *
0126  * The struct declaration for register group ALT_DMASECURE.
0127  */
0128 struct ALT_DMASECURE_s
0129 {
0130     volatile ALT_DMASECURE_REG_t  reg;  /* ALT_DMASECURE_REG */
0131 };
0132
0133 /* The typedef declaration for register group ALT_DMASECURE. */
0134 typedef volatile struct ALT_DMASECURE_s  ALT_DMASECURE_t;
0135 /* The struct declaration for the raw register contents of register group ALT_DMASECURE. */
0136 struct ALT_DMASECURE_raw_s
0137 {
0138     volatile uint32_t  reg;  /* ALT_DMASECURE_REG */
0139 };
0140
0141 /* The typedef declaration for the raw register contents of register group ALT_DMASECURE. */
0142 typedef volatile struct ALT_DMASECURE_raw_s  ALT_DMASECURE_raw_t;
0143 #endif  /* __ASSEMBLY__ */
0144
0145
0146 #ifdef __cplusplus
0147 }
0148 #endif  /* __cplusplus */
0149 #endif  /* __ALTERA_ALT_DMASECURE_H__ */
0150