Skip to content

Commit c399527

Browse files
ivangilmercanoivangilmercano
committed
Adding project documentation for adp1055
Signed-off-by: ivangilmercano <[email protected]>
1 parent 15bee98 commit c399527

File tree

1 file changed

+247
-0
lines changed

1 file changed

+247
-0
lines changed

‎projects/adp1055/README.rst‎

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
ADP1055 no-OS Example Project
2+
=============================
3+
4+
.. contents::
5+
:depth: 3
6+
7+
Supported Evaluation Boards
8+
---------------------------
9+
10+
* `ADP1055DC1-EVALZ <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-adp1055.html#eb-documentation>`_
11+
12+
Overview
13+
--------
14+
15+
The evaluation board allows the ADP1055 to be exercised without the need for
16+
external components. The board is set up to act as an isolated PSU,
17+
outputting a rated load of 12 V, 20 A from a 36 V dc to 75 V dc source.
18+
19+
Full performance details are provided in the ADP1055 data sheet, which should
20+
be consulted in conjunction with user guide.
21+
22+
Hadrware Specifications
23+
-----------------------
24+
25+
Power Supply Requirments
26+
^^^^^^^^^^^^^^^^^^^^^^^^
27+
28+
For this specific project an external power supply is used to provide a 20.1V
29+
and 12V voltages for the ADP1055DC1-EVALZ daughter board to simulate a parallel
30+
circuit to the ADP1055 as well as a +5V Power Supply for the PMBUS/I2C
31+
interface.
32+
33+
**Pin Description**
34+
35+
Please see the following table for the pin assignments for the interface
36+
connectors (J1 and J2).
37+
38+
J1:
39+
40+
+-----+----------+-------------------------------------------+
41+
| Pin | Name | Description |
42+
+-----+----------+-------------------------------------------+
43+
| 1 | 10V_VCC | Do Not Connect |
44+
+-----+----------+-------------------------------------------+
45+
| 2 | VS+ | Power Supply, +12V DC |
46+
+-----+----------+-------------------------------------------+
47+
| 3 | VS- | Connect to Ground |
48+
+-----+----------+-------------------------------------------+
49+
| 4 | CS2+ | Do Not Connect |
50+
+-----+----------+-------------------------------------------+
51+
| 5 | CS2- | Do Not Connect |
52+
+-----+----------+-------------------------------------------+
53+
| 6 | NC | Do Not Connect |
54+
+-----+----------+-------------------------------------------+
55+
| 7 | VFF | Power Supply, +20.1V DC |
56+
+-----+----------+-------------------------------------------+
57+
| 8 | CS1 | Connect to Ground |
58+
+-----+----------+-------------------------------------------+
59+
| 9 | SR1 | Connect to Oscilloscope (Scopy) |
60+
+-----+----------+-------------------------------------------+
61+
| 10 | SR2 | Connect to Oscilloscope (Scopy) |
62+
+-----+----------+-------------------------------------------+
63+
| 11 | OUTA | Connect to Oscilloscope (Scopy) |
64+
+-----+----------+-------------------------------------------+
65+
| 12 | OUTB | Connect to Oscilloscope (Scopy) |
66+
+-----+----------+-------------------------------------------+
67+
| 13 | OUTC | Do Not Connect |
68+
+-----+----------+-------------------------------------------+
69+
| 14 | OUTD | Do Not Connect |
70+
+-----+----------+-------------------------------------------+
71+
| 15 | SYNC | Do Not Connect |
72+
+-----+----------+-------------------------------------------+
73+
| 16 | GPIO4 | Do Not Connect |
74+
+-----+----------+-------------------------------------------+
75+
| 17 | GPIO3 | Do Not Connect |
76+
+-----+----------+-------------------------------------------+
77+
| 18 | GPIO2 | Do Not Connect |
78+
+-----+----------+-------------------------------------------+
79+
| 19 | GPIO1 | Power-Good Signal (GPIO) |
80+
+-----+----------+-------------------------------------------+
81+
| 20 | CTRL | Do Not Connect |
82+
+-----+----------+-------------------------------------------+
83+
| 21 | SCL | I2C Serial Clock (Connect to J2 instead) |
84+
+-----+----------+-------------------------------------------+
85+
| 22 | SDA | I2C Serial Data (Connect to J2 instead) |
86+
+-----+----------+-------------------------------------------+
87+
| 23 | ISHARE | Do Not Connect |
88+
+-----+----------+-------------------------------------------+
89+
| 24 | VCORE | Do Not Connect |
90+
+-----+----------+-------------------------------------------+
91+
| 25 | VDD | Do Not Connect |
92+
+-----+----------+-------------------------------------------+
93+
| 26 | OVP | Do Not Connect |
94+
+-----+----------+-------------------------------------------+
95+
| 27 | DGND | Do Not Connect |
96+
+-----+----------+-------------------------------------------+
97+
| 28 | AGND | Connect to Ground |
98+
+-----+----------+-------------------------------------------+
99+
| 29 | JRTN | Do Not Connect |
100+
+-----+----------+-------------------------------------------+
101+
| 30 | RES | Do Not Connect |
102+
+-----+----------+-------------------------------------------+
103+
| 31 | JTD | Do Not Connect |
104+
+-----+----------+-------------------------------------------+
105+
| 32 | OVP | Do Not Connect |
106+
+-----+----------+-------------------------------------------+
107+
108+
J2:
109+
110+
+-----+----------+-------------------------------------------+
111+
| Pin | Name | Description |
112+
+-----+----------+-------------------------------------------+
113+
| 1 | 10V_VDD | Power Supply, +5V |
114+
+-----+----------+-------------------------------------------+
115+
| 2 | SCL | I2C Serial Clock |
116+
+-----+----------+-------------------------------------------+
117+
| 3 | SDA | I2C Serial Data |
118+
+-----+----------+-------------------------------------------+
119+
| 4 | GND | Connect to Ground |
120+
+-----+----------+-------------------------------------------+
121+
122+
No-OS Build Setup
123+
-----------------
124+
125+
Please see: https://wiki.analog.com/resources/no-os/build
126+
127+
No-OS Supported Examples
128+
------------------------
129+
130+
The initialization data used in the examples is taken out from:
131+
`Project Common Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/adp1055/src/common>`_
132+
133+
The macros used in Common Data are defined in platform specific files found in:
134+
`Project Platform Configuration Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/adp1055/src/platform>`_
135+
136+
Basic example
137+
^^^^^^^^^^^^^
138+
139+
This is a simple example that initializes the ADP1055, unlock its CHIP, EEPROM
140+
and TRIM registers, sets the device in a closed loop state, and then : sets the
141+
VOUT transition rate, VOUT scale and value of the VOUT_COMMAND and VOUT_MAX.
142+
143+
For the PWM it sets the duty cycle on the OUTA channel and then enables the OUTA
144+
channel with a 49KHz frequency, then the DUTY_CYCLE data is read as well as all
145+
the statuses.
146+
147+
In order to build the basic example make sure you have the following configuration in the Makefile
148+
`Makefile <https://github.com/analogdevicesinc/no-OS/tree/main/projects/adp1055/Makefile>`_
149+
150+
.. code-block:: bash
151+
152+
# Select the example you want to enable by choosing y for enabling and n for disabling
153+
BASIC_EXAMPLE = y
154+
IIO_EXAMPLE = n
155+
156+
IIO example
157+
^^^^^^^^^^^
158+
159+
This project is actually a IIOD demo for ADP1055DC1-EVALZ evaluation board.
160+
The project launches a IIOD server on the board so that the user may connect
161+
to it via an IIO client.
162+
Using IIO-Oscilloscope, the user can configure the IMU and view the measured data on a plot.
163+
164+
If you are not familiar with ADI IIO Application, please take a look at:
165+
`IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`_
166+
167+
If you are not familiar with ADI IIO-Oscilloscope Client, please take a look at:
168+
`IIO Oscilloscope <https://wiki.analog.com/resources/tools-software/linux-software/iio_oscilloscope>`_
169+
170+
The No-OS IIO Application together with the No-OS IIO ADP1055 driver take care of
171+
all the back-end logic needed to setup the IIO server.
172+
173+
This example initializes the IIO device and calls the IIO app as shown in:
174+
`IIO Example <https://github.com/analogdevicesinc/no-OS/tree/main/projects/adp1055/src/examples/iio_example>`_
175+
176+
In order to build the IIO project make sure you have the following configuration in the
177+
`Makefile <https://github.com/analogdevicesinc/no-OS/tree/main/projects/adp1055/Makefile>`_
178+
179+
.. code-block:: bash
180+
181+
# Select the example you want to enable by choosing y for enabling and n for disabling
182+
BASIC_EXAMPLE = n
183+
IIO__EXAMPLE = y
184+
185+
No-OS Supported Platforms
186+
-------------------------
187+
188+
Maxim Platform
189+
^^^^^^^^^^^^^^
190+
191+
**Used hardware**
192+
193+
* `ADP1055DC1-EVALZ daughter board <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/eval-adp1055.html#eb-overview>`_
194+
* `AD-APARD32690-SL <https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html>`_
195+
196+
**Connections**:
197+
198+
J1:
199+
200+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
201+
| ADP1055DC1-EVALZ Pin Number | Mnemonic | Function | AD-APARD32690-SL Pin Number |
202+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
203+
| 2 | VS+ | External Power Supply, 12VDC (5mA current) | GND |
204+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
205+
| 3 | VS- | Connect to Ground | Do Not Connect |
206+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
207+
| 7 | VF | External Power Supply, 20.1VDC (5mA current) | Do Not Connect |
208+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
209+
| 8 | CS1 | Ground | GND |
210+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
211+
| 9 | SR1 | SR1 channel output (May connect to Scopy) | Do Not Connect |
212+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
213+
| 10 | SR2 | SR2 channel output (May connect to Scopy) | Do Not Connect |
214+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
215+
| 11 | OUTA | OUTA channel output (May connect to Scopy) | Do Not Connect |
216+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
217+
| 12 | OUTB | OUTB channel output (May connect to Scopy) | Do Not Connect |
218+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
219+
| 19 | PG/ALT# | Power-Good Signal Logic OUTPUT | P0_24 |
220+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
221+
| 28 | AGND | Ground | GND |
222+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
223+
224+
J2:
225+
226+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
227+
| ADP1055DC1-EVALZ Pin Number | Mnemonic | Function | AD-APARD32690-SL Pin Number |
228+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
229+
| 1 | 10V_VDD | Power Supply, +5VDC | 5V0 |
230+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
231+
| 2 | SCL | I2C Serial Clock | I2C0_SCL |
232+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
233+
| 3 | SDA | I2C Serial Data | I2C0_SDA |
234+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
235+
| 4 | GND | Ground | GND |
236+
+-----------------------------+------------+----------------------------------------------+-----------------------------+
237+
238+
**Build Command**
239+
240+
.. code-block:: bash
241+
242+
# to delete current build
243+
make reset
244+
# to build the project
245+
make PLATFORM=maxim TARGET=max32690
246+
# to flash the code
247+
make run

0 commit comments

Comments
 (0)