Skip to content

Commit 8e480e9

Browse files
csaripcsarip
committed
projects: ltc2378: Add README documentation for project
Add README.rst documentation file for project alongside other documentation related files. Signed-off-by: Cherrence Sarip <cherrence.sarip@analog.com>
1 parent 48a9c78 commit 8e480e9

File tree

2 files changed

+163
-0
lines changed

2 files changed

+163
-0
lines changed

‎doc/sphinx/source/projects/adc/ltc2378.rst‎

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

‎projects/ltc2378/README.rst‎

Lines changed: 162 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,162 @@
1+
Evaluating the LTC2378-20
2+
======================
3+
4+
.. no-os-doxygen::
5+
6+
.. contents::
7+
:depth: 3
8+
9+
Supported Evaluation Boards
10+
---------------------------
11+
12+
- :adi:`DC2135A`
13+
14+
Overview
15+
--------
16+
17+
The DC2135A evaluation board features the LTC2378-20, a high-speed 20-bit SAR
18+
ADC that can be configured for both unipolar (0 to VREF) and bipolar (±VREF)
19+
input ranges. The board provides all necessary hardware connections and signal
20+
conditioning for comprehensive ADC evaluation.
21+
22+
The evaluation board provides easy access to all necessary signals through
23+
standard connectors, enabling quick setup for high-speed data acquisition
24+
applications up to 1Msps sample rate.
25+
26+
For full performance details, refer to the LTC2378-20 data sheet, which should
27+
be consulted in conjunction with the user guide.
28+
29+
Hardware Specifications
30+
-----------------------
31+
32+
Power Supply Requirements
33+
^^^^^^^^^^^^^^^^^^^^^^^^^
34+
35+
The DC2135A evaluation board requires external ±16V supplies for the analog
36+
input circuitry and signal conditioning. The LTC2378-20 ADC itself operates
37+
from a regulated 2.5V supply that is generated on-board.
38+
39+
**Pin Description**
40+
41+
Please see the following table for the pin assignments:
42+
43+
+----------+-------------------------------------------+
44+
| Name | Description |
45+
+----------+-------------------------------------------+
46+
| GND | Connect to Ground |
47+
+----------+-------------------------------------------+
48+
| SCK | Connect to SPI Clock (SCK) |
49+
+----------+-------------------------------------------+
50+
| SDO | Connect to SPI Master In Slave Out (MISO) |
51+
+----------+-------------------------------------------+
52+
| SDI | Connect to SPI Master Out Slave In (MOSI) |
53+
+----------+-------------------------------------------+
54+
| CNV | Connect to GPIO pin (CNV) |
55+
+----------+-------------------------------------------+
56+
| BUSY | Connect to GPIO pin (BUSY) |
57+
+----------+-------------------------------------------+
58+
59+
**Hardware Bringup**
60+
61+
For reference, consult the Quick Start Procedure section in the user guide for the corresponding demo board:
62+
`DC2135A user guide <https://www.analog.com/media/en/technical-documentation/user-guides/DC2135AF.PDF>`_.
63+
64+
No-OS Build Setup
65+
-----------------
66+
67+
Please see: https://wiki.analog.com/resources/no-os/build
68+
69+
No-OS Supported Examples
70+
------------------------
71+
72+
The initialization data used in the examples is taken out from:
73+
`Project Common Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc2378/src/common>`_
74+
75+
The macros used in Common Data are defined in platform specific files found in:
76+
`Project Platform Configuration Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc2378/src/platform>`_
77+
78+
Basic example
79+
^^^^^^^^^^^^^
80+
81+
This is a simple example that initializes the LTC2378-20, perform the start-up
82+
sequence and configure the output voltage.
83+
84+
In order to build the basic example make sure you have the following
85+
configuration in the
86+
`Makefile <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc2378/Makefile>`_
87+
88+
.. code-block:: bash
89+
90+
# Select the example you want to enable by choosing y for enabling and n for disabling
91+
BASIC_EXAMPLE = y
92+
IIO_EXAMPLE = n
93+
94+
IIO example
95+
^^^^^^^^^^^
96+
97+
This project is actually an IIOD demo for DC2135A evaluation board.
98+
The project launches a IIOD server on the board so that the user may connect
99+
to it via an IIO client.
100+
101+
Using IIO-Oscilloscope, the user can configure the device.
102+
103+
If you are not familiar with ADI IIO Application, please take a look at:
104+
`IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`_
105+
106+
If you are not familiar with ADI IIO-Oscilloscope Client, please take a look at:
107+
`IIO Oscilloscope <https://wiki.analog.com/resources/tools-software/linux-software/iio_oscilloscope>`_
108+
109+
The No-OS IIO Application together with the No-OS IIO LTC2378-20 driver take care of
110+
all the back-end logic needed to setup the IIO server.
111+
112+
This example initializes the IIO device and calls the IIO app as shown in:
113+
`IIO Example <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc2378/src/examples/iio_example>`_
114+
115+
In order to build the IIO project make sure you have the following configuration
116+
in the
117+
`Makefile <https://github.com/analogdevicesinc/no-OS/tree/main/projects/ltc2378/Makefile>`_
118+
119+
.. code-block:: bash
120+
121+
# Select the example you want to enable by choosing y for enabling and n for disabling
122+
BASIC_EXAMPLE = n
123+
IIO_EXAMPLE = y
124+
125+
No-OS Supported Platforms
126+
-------------------------
127+
128+
Maxim Platform
129+
^^^^^^^^^^^^^^
130+
131+
**Used hardware**
132+
133+
* `DC2135A <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/dc2135a.html>`_
134+
* `MAX32666FTHR <https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html>`_
135+
136+
**Connections**:
137+
138+
139+
+--------------------------+----------------------------------------------+------------------+
140+
| DC2135A Pin | Function | MAX32666FTHR Pin |
141+
+--------------------------+----------------------------------------------+------------------+
142+
| SCK | SPI Clock (SCK) | AIN3 (SPI1_SCK) |
143+
+--------------------------+----------------------------------------------+------------------+
144+
| SDO | SPI Master In Slave Out (MISO) | AIN2 (SPI1_MISO) |
145+
+--------------------------+----------------------------------------------+------------------+
146+
| SDI | SPI Master Out Slave In (MOSI) | AIN1 (SPI1_MOSI) |
147+
+--------------------------+----------------------------------------------+------------------+
148+
| CNV | GPIO (CNV Pin) | P0_9 |
149+
+--------------------------+----------------------------------------------+------------------+
150+
| BUSY | GPIO (BUSY Pin) | P0_10 |
151+
+--------------------------+----------------------------------------------+------------------+
152+
| GND | Ground (GND) | GND |
153+
+--------------------------+----------------------------------------------+------------------+
154+
155+
**Build Command**
156+
157+
.. code-block:: bash
158+
159+
# to delete current build
160+
make PLATFORM=maxim TARGET=max32665 reset
161+
# to build the project and flash the code
162+
make PLATFORM=maxim TARGET=max32665 run

0 commit comments

Comments
 (0)