Folder Structure - Analog Devices ADRV9001 User Manual

Preliminary Technical Data UG-1828

FOLDER STRUCTURE

Source files are provided by ADI in the folder structure shown in Figure 14. Each subfolder is explained in the following sections. ADI
understands that the developer may desire to use a different folder structure. Whereas Analog Devices provides ADRV9001 API source
code releases in the folder structure shown below, the developer may organize the ADRV9001 API into a custom folder organization ,if
required. This operation, however, does not permit the developer the right to modify the content of the ADRV9001 API source code.
Figure 14. API Folder Structure
/c_src/common
Common code shared between all the devices, this contains: error handling facilities, logging faclities, and HAL access facilities.
/c_src/boards
This section contains the API for the ADI evaluation board, it can see all the devices that are present in the board and implements
functions like the board initialize function.
/c_src/devices
The devices folder includes the main API code for the ADRV9001 transceiver as well as auxiliary devices APIs used for the demo of
ADRV9001. The /adrv9001 folder contains the high level function prototypes, data types, macros, and source code used to build the final
user software system. The user is strictly forbidden to modify the files contained in the /adrv9001 or other devices in this section,
software support is not provided when these files have been modified. Analog Devices maintains this code. The only exception is that
user may modify #define macros in adi_adrv9001_user.h such as ADI_ADRV9001_VERBOSE mode to enable/disable API logging.
Rev. PrA | Page 31 of 253