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