Update some C comments

This commit is contained in:
Gregory Nutt 2016-07-02 09:04:27 -06:00
parent adbbca0bfc
commit 042c9d0b38

View File

@ -50,7 +50,13 @@
************************************************************************************/
/* Clocking *************************************************************************/
/* The K60 tower board uses a 50MHz external clock */
/* The Freedom K64F uses a 50MHz external clock from the Micrel Ethernet PHY. The
* Kinetis MCU startup from an internal digitally-controlled oscillator (DCO). Nuttx
* will enable the main external oscillator (EXTAL0/XTAL0). The external
* oscillator/resonator can range from 32.768 KHz up to 50 MHz. The default external
* source for the MCG oscillator inputs (EXTAL) is 50 MHz clock source from Micrel
* Ethernet PHY.
*/
#define BOARD_EXTCLOCK 1 /* External clock */
#define BOARD_EXTAL_FREQ 48000000 /* 50MHz Oscillator */
@ -186,216 +192,12 @@
/* Alternative pin resolution *******************************************************/
/* If there are alternative configurations for various pins in the
* k64_k60pinmux.h header file, those alternative pins will be labeled with a
* kinetis_k64pinmux.h header file, those alternative pins will be labeled with a
* suffix like _1, _2, etc. The logic in this file must select the correct pin
* configuration for the board by defining a pin configuration (with no suffix) that
* maps to the correct alternative.
*/
/* On-Board Connections
* -------------------- ------------------------- -------- -------------------
* FEATURE CONNECTION PORT/PIN PIN FUNCTION
* -------------------- ------------------------- -------- -------------------
* OSJTAG USB-to-serial OSJTAG Bridge RX Data PTE9 UART5_RX
* Bridge OSJTAG Bridge TX Data PTE8 UART5_TX
* SD Card Slot SD Clock PTE2 SDHC0_DCLK
* SD Command PTE3 SDHC0_CMD
* SD Data0 PTE1 SDHC0_D0
* SD Data1 PTE0 SDHC0_D1
* SD Data2 PTE5 SDHC0_D2
* SD Data3 PTE4 SDHC0_D3
* SD Card Detect PTE28 PTE28
* SD Write Protect PTE27 PTE27
* Infrared Port IR Transmit PTD7 CMT_IRO
* IR Receive PTC6 CMP0_IN0
* Pushbuttons SW1 (IRQ0) PTA19 PTA19
* SW2 (IRQ1) PTE26 PTE26
* SW3 (RESET) RESET_b RESET_b
* Touch Pads E1 / Touch PTA4 TSI0_CH5
* E2 / Touch PTB3 TSI0_CH8
* E3 / Touch PTB2 TSI0_CH7
* E4 / Touch PTB16 TSI0_CH9
* LEDs E1 / Orange LED PTA11 PTA11
* E2 / Yellow LED PTA28 PTA28
* E3 / Green LED PTA29 PTA29
* E4 / Blue LED PTA10 PTA10
* Potentiometer Potentiometer (R71) ? ADC1_DM1
* Accelerometer I2C SDA PTD9 I2C0_SDA
* I2C SCL PTD8 I2C0_SCL
* IRQ PTD10 PTD10
* Touch Pad / Segment Electrode 0 (J3 Pin 3) PTB0 TSI0_CH0
* LCD TWRPI Socket Electrode 1 (J3 Pin 5) PTB1 TSI0_CH6
* Electrode 2 (J3 Pin 7) PTB2 TSI0_CH7
* Electrode 3 (J3 Pin 8) PTB3 TSI0_CH8
* Electrode 4 (J3 Pin 9) PTC0 TSI0_CH13
* Electrode 5 (J3 Pin 10) PTC1 TSI0_CH14
* Electrode 6 (J3 Pin 11) PTC2 TSI0_CH15
* Electrode 7 (J3 Pin 12) PTA4 TSI0_CH5
* Electrode 8 (J3 Pin 13) PTB16 TSI0_CH9
* Electrode 9 (J3 Pin 14) PTB17 TSI0_CH10
* Electrode 10 (J3 Pin 15) PTB18 TSI0_CH11
* Electrode 11 (J3 Pin 16) PTB19 TSI0_CH12
* TWRPI ID0 (J3 Pin 17) ? ADC1_DP1
* TWRPI ID1 (J3 Pin 18) ? ADC1_SE16
*/
#define PIN_UART5_RX PIN_UART5_RX_2
#define PIN_UART5_TX PIN_UART5_TX_2
#define PIN_I2C0_SDA PIN_I2C0_SDA_3
#define PIN_I2C0_SCL PIN_I2C0_SCL_3
/* Connections via the General Purpose Tower Plug-in (TWRPI) Socket
* -------------------- ------------------------- -------- -------------------
* FEATURE CONNECTION PORT/PIN PIN FUNCTION
* -------------------- ------------------------- -------- -------------------
* General Purpose TWRPI AN0 (J4 Pin 8) ? ADC0_DP0/ADC1_DP3
* TWRPI Socket TWRPI AN1 (J4 Pin 9) ? ADC0_DM0/ADC1_DM3
* TWRPI AN2 (J4 Pin 12) ? ADC1_DP0/ADC0_DP3
* TWRPI ID0 (J4 Pin 17) ? ADC0_DP1
* TWRPI ID1 (J4 Pin 18) ? ADC0_DM1
* TWRPI I2C SCL (J5 Pin 3) PTD8 I2C0_SCL
* TWRPI I2C SDA (J5 Pin 4) PTD9 I2C0_SDA
* TWRPI SPI MISO (J5 Pin 9) PTD14 SPI2_SIN
* TWRPI SPI MOSI (J5 Pin 10) PTD13 SPI2_SOUT
* TWRPI SPI SS (J5 Pin 11) PTD15 SPI2_PCS0
* TWRPI SPI CLK (J5 Pin 12) PTD12 SPI2_SCK
* TWRPI GPIO0 (J5 Pin 15) PTD10 PTD10
* TWRPI GPIO1 (J5 Pin 16) PTB8 PTB8
* TWRPI GPIO2 (J5 Pin 17) PTB9 PTB9
* TWRPI GPIO3 (J5 Pin 18) PTA19 PTA19
* TWRPI GPIO4 (J5 Pin 19) PTE26 PTE26
*/
#define PIN_SPI2_SIN PIN_SPI2_SIN_2
#define PIN_SPI2_SOUT PIN_SPI2_SOUT_2
#define PIN_SPI2_SCK PIN_SPI2_SCK_2
/* Connections via the Tower Primary Connector Side A
* --- -------------------- --------------------------------
* PIN NAME USAGE
* --- -------------------- --------------------------------
* A7 SCL0 PTD8
* A8 SDA0 PTD9
* A9 GPIO9 / CTS1 PTC19
* A10 GPIO8 / SDHC_D2 PTE5
* A11 GPIO7 / SD_WP_DET PTE27
* A13 ETH_MDC PTB1
* A14 ETH_MDIO PTB0
* A16 ETH_RXDV PTA14
* A19 ETH_RXD1 PTA12
* A20 ETH_RXD0 PTA13
* A21 SSI_MCLK PTE6
* A22 SSI_BCLK PTE12
* A23 SSI_FS PTE11
* A24 SSI_RXD PTE7
* A25 SSI_TXD PTE10
* A27 AN3 PGA0_DP/ADC0_DP0/ADC1_DP3
* A28 AN2 PGA0_DM/ADC0_DM0/ADC1_DM3
* A29 AN1 PGA1_DP/ADC1_DP0/ADC0_DP3
* A30 AN0 PGA1_DM/ADC1_DM0/ADC0_DM3
* A33 TMR1 PTA9
* A34 TMR0 PTA8
* A35 GPIO6 PTB9
* A37 PWM3 PTA6
* A38 PWM2 PTC3
* A39 PWM1 PTC2
* A40 PWM0 PTC1
* A41 RXD0 PTE25
* A42 TXD0 PTE24
* A43 RXD1 PTC16
* A44 TXD1 PTC17
* A64 CLKOUT0 PTC3
* A66 EBI_AD14 PTC0
* A67 EBI_AD13 PTC1
* A68 EBI_AD12 PTC2
* A69 EBI_AD11 PTC4
* A70 EBI_AD10 PTC5
* A71 EBI_AD9 PTC6
* A71 EBI_R/W_b PTC11
* A72 EBI_AD8 PTC7
* A73 EBI_AD7 PTC8
* A74 EBI_AD6 PTC9
* A75 EBI_AD5 PTC10
* A76 EBI_AD4 PTD2
* A77 EBI_AD3 PTD3
* A78 EBI_AD2 PTD4
* A79 EBI_AD1 PTD5
* A80 EBI_AD0 PTD6
*/
/* PTE 26/27 */
#define PIN_UART3_RX PIN_UART3_RX_2
#define PIN_UART3_TX PIN_UART3_TX_2
/* PTE 24/25 */
#define PIN_UART4_RX PIN_UART4_RX_2
#define PIN_UART4_TX PIN_UART4_TX_2
/* Connections via the Tower Primary Connector Side B
* --- -------------------- --------------------------------
* PIN NAME USAGE
* --- -------------------- --------------------------------
* B7 SDHC_CLK / SPI1_CLK PTE2
* B9 SDHC_D3 / SPI1_CS0_b PTE4
* B10 SDHC_CMD / SPI1_MOSI PTE1
* B11 SDHC_D0 / SPI1_MISO PTE3
* B13 ETH_RXER PTA5
* B15 ETH_TXEN PTA15
* B19 ETH_TXD1 PTA17
* B20 ETH_TXD0 PTA16
* B21 GPIO1 / RTS1 PTC18
* B22 GPIO2 / SDHC_D1 PTE0
* B23 GPIO3 PTE28
* B24 CLKIN0 PTA18
* B25 CLKOUT1 PTE26
* B27 AN7 PTB7
* B28 AN6 PTB6
* B29 AN5 PTB5
* B30 AN4 PTB4
* B34 TMR2 PTD6
* B35 GPIO4 PTB8
* B37 PWM7 PTA2
* B38 PWM6 PTA1
* B39 PWM5 PTD5
* B40 PWM4 PTA7
* B41 CANRX0 PTE25
* B42 CANTX0 PTE24
* B44 SPI0_MISO PTD14
* B45 SPI0_MOSI PTD13
* B46 SPI0_CS0_b PTD11
* B47 SPI0_CS1_b PTD15
* B48 SPI0_CLK PTD12
* B50 SCL1 PTD8
* B51 SDA1 PTD9
* B52 GPIO5 / SD_CARD_DET PTE28
* B55 IRQ_H PTA24
* B56 IRQ_G PTA24
* B57 IRQ_F PTA25
* B58 IRQ_E PTA25
* B59 IRQ_D PTA26
* B60 IRQ_C PTA26
* B61 IRQ_B PTA27
* B62 IRQ_A PTA27
* B63 EBI_ALE / EBI_CS1_b PTD0
* B64 EBI_CS0_b PTD1
* B66 EBI_AD15 PTB18
* B67 EBI_AD16 PTB17
* B68 EBI_AD17 PTB16
* B69 EBI_AD18 PTB11
* B70 EBI_AD19 PTB10
* B72 EBI_OE_b PTB19
* B73 EBI_D7 PTB20
* B74 EBI_D6 PTB21
* B75 EBI_D5 PTB22
* B76 EBI_D4 PTB23
* B77 EBI_D3 PTC12
* B78 EBI_D2 PTC13
* B79 EBI_D1 PTC14
* B80 EBI_D0 PTC15
*/
/************************************************************************************
* Public Data
************************************************************************************/