PIC24 Support Libraries
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
pic24_support_dox.h
1 /*
2  * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
3  * All rights reserved.
4  * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
5  * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
6  * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State University)
7  *
8  * Permission to use, copy, modify, and distribute this software and its
9  * documentation for any purpose, without fee, and without written agreement is
10  * hereby granted, provided that the above copyright notice, the following
11  * two paragraphs and the authors appear in all copies of this software.
12  *
13  * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
15  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
16  * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
17  *
18  * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21  * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
23  *
24  * Please maintain this header in its entirety when copying/modifying
25  * these files.
26  *
27  *
28  */
29 
30 // Documentation placed on the PIC24 support library page. This file only
31 // include comments for Doxygen; it does not contain any
32 // code.
33 /**
34  * \page PIC24_support PIC24 support library
35  * The PIC24 support library is divided into
36  * \ref external "external components", \ref internal "internal components",
37  * and \ref codeUtils "utilities" used in creating the library.
38  * External components should be called by
39  * the typical user to set up the PIC, communicate over the UART,
40  * I<sup>2</sup>C bus, etc. Internal components include both
41  * implementation details and information on adding support for
42  * PIC24 processors not currently supported by this library.
43  *
44  * A simple example which echos characters via the UART:
45 \code
46 #include "pic24_all.h"
47 int main(void) {
48  // Set up clock, heartbeat, UART, print welcome message
49  configBasic(HELLO_MSG);
50  while (1) {
51  // Echo characters
52  outChar(inChar());
53  }
54  return 0;
55 }
56 \endcode
57  *
58  * \section libraryComponents Library components
59  *
60  * \subsection external External library components
61  * - Development support
62  * - A single header file to include all the files below,
63  * in pic24_all.h
64  * - Delay routines in pic24_delay.h
65  * - Setup of IO ports in pic24_ports.h
66  * - Unit testing / assertions, in pic24_unittest.h
67  * - Miscellanous utilities in pic24_util.h
68  * - Processor-specific information in pic24_chip.h
69  * - Debug/data tranfer abilities in dataXfer.h
70  * - A byte-wise access to multibyte data in pic24_unions.h
71  * - Peripheral support
72  * - Analog to digital converter routines, in pic24_adc.h
73  * - Direct memory access (DMA) routines, in pic24_dma.h
74  * - Enhanced controller area network (ECAN) routines, in pic24_ecan.h
75  * - Read/write of FLASH, in pic24_flash.h
76  * - Setup of timers, in pic24_timer.h
77  * - Serial communication support, in pic24_serial.h
78  * - I<sup>2</sup>C support, in pic24_i2c.h
79  * - SPI support, in pic24_spi.h
80  *
81  * \subsection internal Internal library components
82  * - User-configurable library settings, in pic24_libconfig.h
83  * - Clock configuration, in pic24_clockfreq.h and
84  * pic24_clockfreq.c
85  * - Configuration bit settings, in pic24_configbits.c
86  * - UART support in pic24_uart.h and pic24_uart.c, which
87  * is typically called by routines in pic24_serial.h.
88  *
89  * \subsection codeUtils Utilities
90  * The <a href="sphinx/utilities.html">utilities</a> page documents tools for library development and maintenance.
91  */