1 /******************************************************************************
2 *  Filename:       adi_doc.h
3 *
4 *  Copyright (c) 2015 - 2022, Texas Instruments Incorporated
5 *  All rights reserved.
6 *
7 *  Redistribution and use in source and binary forms, with or without
8 *  modification, are permitted provided that the following conditions are met:
9 *
10 *  1) Redistributions of source code must retain the above copyright notice,
11 *     this list of conditions and the following disclaimer.
12 *
13 *  2) Redistributions in binary form must reproduce the above copyright notice,
14 *     this list of conditions and the following disclaimer in the documentation
15 *     and/or other materials provided with the distribution.
16 *
17 *  3) Neither the name of the ORGANIZATION nor the names of its contributors may
18 *     be used to endorse or promote products derived from this software without
19 *     specific prior written permission.
20 *
21 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
25 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 *  POSSIBILITY OF SUCH DAMAGE.
32 *
33 ******************************************************************************/
34 //! \addtogroup adi_api
35 //! @{
36 //! \section sec_adi Introduction
37 //! \n
38 //!
39 //! \section sec_adi_api API
40 //!
41 //! The API functions can be grouped like this:
42 //!
43 //! Write:
44 //! - Direct (all bits):
45 //!   - \ref ADI8RegWrite()
46 //!   - \ref ADI16RegWrite()
47 //!   - \ref ADI32RegWrite()
48 //! - Set individual bits:
49 //!   - \ref ADI8BitsSet()
50 //!   - \ref ADI16BitsSet()
51 //!   - \ref ADI32BitsSet()
52 //! - Clear individual bits:
53 //!   - \ref ADI8BitsClear()
54 //!   - \ref ADI16BitsClear()
55 //!   - \ref ADI32BitsClear()
56 //! - Masked:
57 //!   - \ref ADI4SetValBit()
58 //!   - \ref ADI8SetValBit()
59 //!   - \ref ADI16SetValBit()
60 //!
61 //! Read:
62 //! - \ref ADI8RegRead()
63 //! - \ref ADI16RegRead()
64 //! - \ref ADI32RegRead()
65 //!
66 //! @}
67