1 #ifndef __ALT_AVALON_SPI_H__
2 #define __ALT_AVALON_SPI_H__
3 
4 /******************************************************************************
5 *                                                                             *
6 * License Agreement                                                           *
7 *                                                                             *
8 * Copyright (c) 2003 Altera Corporation, San Jose, California, USA.           *
9 * All rights reserved.                                                        *
10 *                                                                             *
11 * Permission is hereby granted, free of charge, to any person obtaining a     *
12 * copy of this software and associated documentation files (the "Software"),  *
13 * to deal in the Software without restriction, including without limitation   *
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,    *
15 * and/or sell copies of the Software, and to permit persons to whom the       *
16 * Software is furnished to do so, subject to the following conditions:        *
17 *                                                                             *
18 * The above copyright notice and this permission notice shall be included in  *
19 * all copies or substantial portions of the Software.                         *
20 *                                                                             *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR  *
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,    *
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER      *
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING     *
26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER         *
27 * DEALINGS IN THE SOFTWARE.                                                   *
28 *                                                                             *
29 *                                                                             *
30 ******************************************************************************/
31 #include <stddef.h>
32 
33 #include "alt_types.h"
34 
35 #ifdef __cplusplus
36 extern "C"
37 {
38 #endif /* __cplusplus */
39 
40 /*
41  * Macros used by alt_sys_init
42  */
43 
44 #define ALTERA_AVALON_SPI_INSTANCE(name, device) extern int alt_no_storage
45 #define ALTERA_AVALON_SPI_INIT(name, device) while (0)
46 
47 /*
48  * Use this function to perform one SPI access on your target.  'base' should
49  * be the base address of your SPI peripheral, while 'slave' indicates which
50  * bit in the slave select register should be set.
51  */
52 
53 /* If you need to make multiple accesses to the same slave then you should
54  * set the merge bit in the flags for all of them except the first.
55  */
56 #define ALT_AVALON_SPI_COMMAND_MERGE (0x01)
57 
58 /*
59  * If you need the slave select line to be toggled between words then you
60  * should set the toggle bit in the flag.
61  */
62 #define ALT_AVALON_SPI_COMMAND_TOGGLE_SS_N (0x02)
63 
64 
65 int alt_avalon_spi_command(alt_u32 base, alt_u32 slave,
66                            alt_u32 write_length, const alt_u8 * write_data,
67                            alt_u32 read_length, alt_u8 * read_data,
68                            alt_u32 flags);
69 
70 #ifdef __cplusplus
71 }
72 #endif /* __cplusplus */
73 
74 #endif /* __ALT_AVALON_SPI_H__ */
75