MAX32665 SDK Documentation  0.2
Software Development Kit Overview and API Documentation
board.h
1 /*******************************************************************************
2  * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17  * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
18  * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Except as contained in this notice, the name of Maxim Integrated
23  * Products, Inc. shall not be used except as stated in the Maxim Integrated
24  * Products, Inc. Branding Policy.
25  *
26  * The mere transfer of this software does not imply any licenses
27  * of trade secrets, proprietary technology, copyrights, patents,
28  * trademarks, maskwork rights, or any other form of intellectual
29  * property whatsoever. Maxim Integrated Products, Inc. retains all
30  * ownership rights.
31  *
32  * $Date: 2018-08-29 14:57:14 -0500 (Wed, 29 Aug 2018) $
33  * $Revision: 37501 $
34  *
35  ******************************************************************************/
36 
43 #include <stdio.h>
44 #include "spixfc.h"
45 
46 #ifndef _BOARD_H
47 #define _BOARD_H
48 
49 #ifdef __cplusplus
50 extern "C" {
51 #endif
52 
53 #ifndef CONSOLE_UART
54 #define CONSOLE_UART 1
55 #endif
56 
57 #ifndef CONSOLE_BAUD
58 #define CONSOLE_BAUD 115200
59 #endif
60 
61 #define LED_OFF 1
62 #define LED_ON 0
63 
64 #define MX25_SPI MXC_SPIXFC
65 #define MX25_SSEL 0
66 // #define SPI_CHAR_BITS 8
67 
68 
73 int Board_Init(void);
74 
80 int Console_Init(void);
81 
86 int Console_PrepForSleep(void);
87 
93 int Console_Shutdown(void);
94 
99 int MX25_Board_Init(void);
100 
110 int MX25_Board_Read(uint8_t* read, unsigned len, unsigned deassert, spixfc_width_t width);
120 int MX25_Board_Write(const uint8_t* write, unsigned len, unsigned deassert, spixfc_width_t width);
121 
128 int MX25_Clock(unsigned len, unsigned deassert);;
129 
130 #ifdef __cplusplus
131 }
132 #endif
133 
134 #endif /* _BOARD_H */
spixfc_width_t
Number of data lines to use.
Definition: spixfc.h:80