Skip to content

Commit e2c0d9b

Browse files
committed
projects: max22007: Add README for MAX22007 project
Add documentation for MAX22007 example project Signed-off-by: Janani Sunil <janani.sunil@analog.com>
1 parent ac524b9 commit e2c0d9b

File tree

2 files changed

+115
-0
lines changed

2 files changed

+115
-0
lines changed
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../../../../projects/max22007/README.rst

projects/max22007/README.rst

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
MAX22007EVKIT no-OS Example Project
2+
===================================
3+
4+
.. no-os-doxygen::
5+
6+
.. contents::
7+
:depth: 3
8+
9+
Supported Evaluation Boards
10+
---------------------------
11+
12+
* `MAX22007EVKIT <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max22007evkit.html>`_
13+
14+
Overview
15+
--------
16+
17+
The MAX22007EVKIT is a fully featured evaluation kit for the MAX22007.
18+
This board operates in standalone mode or in conjunction with SDP-K1
19+
20+
Hardware Specifications
21+
-----------------------
22+
23+
The MAX22007EVKIT device has to be supplied with a 7-9V DC voltage and
24+
a 3V3 VDRIVE voltage from the microcontroller (for the logic level
25+
voltage of the SPI communication).
26+
27+
**Pin Description**
28+
29+
Please see the following table for the pin assignments for the
30+
interface connector (SPI Test Points).
31+
32+
+------------+--------+----------------------------------+
33+
| Pin | Name | Description |
34+
+------------+--------+----------------------------------+
35+
| PMOD1 pin1 | CSB | SPI Chip-Select |
36+
+------------+--------+----------------------------------+
37+
| PMOD1 pin2 | SDO | Master-Out Slave-In (MOSI) |
38+
+------------+--------+----------------------------------+
39+
| PMOD1 pin3 | SDI | Master-In Slave-Out (MISO) |
40+
+------------+--------+----------------------------------+
41+
| PMOD1 pin4 | SCLK | Serial Clock |
42+
+------------+--------+----------------------------------+
43+
44+
Please ensure to open all the switches on SW1, to ensure compatibility
45+
with an external MCU
46+
47+
Please refer to the `MAX22007EVKIT Board user guide <https://www.analog.com/media/en/technical-documentation/data-sheets/max22007evkit.pdf>`_ for more details on jumper positions.
48+
49+
No-OS Build Setup
50+
-----------------
51+
52+
`Please see: <https://wiki.analog.com/resources/no-os/build>`_
53+
54+
No-OS Supported Examples
55+
------------------------
56+
57+
The initialization data used in the examples is taken out from:
58+
`Project Common Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/max22007/src/common>`_
59+
60+
The macros used in Common Data are defined in platform specific files found in:
61+
`Project Platform Configuration Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/max22007/src/platform>`_
62+
63+
Basic Example
64+
^^^^^^^^^^^^^
65+
66+
This is a simple example which initializes the MAX22007 and writes to the data register of channel 0 and 3 with a value
67+
equivalent to 2v and 4v respectively.
68+
69+
In order to build the basic example make sure you have the following configuration in the Makefile
70+
`Makefile <https://github.com/analogdevicesinc/no-OS/tree/main/projects/max22007/Makefile>`_
71+
72+
.. code-block:: bash
73+
74+
EXAMPLE ?= basic_example
75+
76+
77+
No-OS Supported Platforms
78+
-------------------------
79+
80+
STM32 Platform
81+
^^^^^^^^^^^^^^
82+
83+
**Used Hardware**
84+
85+
* `MAX22007EVKIT <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max22007evkit.html>`_
86+
* `SDP-K1 <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/sdp-k1.html>`_
87+
88+
**Connections**:
89+
90+
+---------------------+--------+----------------------------------+--------------------+
91+
| MAX22007EVKIT Pin | Signal | Function | SDP-K1 Pin Number |
92+
+---------------------+--------+----------------------------------+--------------------+
93+
| PMOD1 pin1 | CSB | SPI interface Chip-Select | D10 |
94+
+---------------------+--------+----------------------------------+--------------------+
95+
| PMOD1 pin2 | SDO | Master-Out Slave-In (MOSI) | D11 |
96+
+---------------------+--------+----------------------------------+--------------------+
97+
| PMOD1 pin3 | SDI | Master-In Slave-Out (MISO) | D12 |
98+
+---------------------+--------+----------------------------------+--------------------+
99+
| PMOD1 pin4 | SCLK | SPI interface Serial Clock Line | D13 |
100+
+---------------------+--------+----------------------------------+--------------------+
101+
| GND | GND | Ground | GND |
102+
+---------------------+--------+----------------------------------+--------------------+
103+
104+
**Build Command**
105+
106+
.. code-block:: bash
107+
108+
# to delete current build
109+
make reset
110+
# to build the project
111+
make PLATFORM=stm32 HARDWARE=sdp-k1.ioc
112+
# to flash the code
113+
make run
114+

0 commit comments

Comments
 (0)