Toyomasa Watarai / mbed-src

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-src by mbed official

targets/hal/TARGET_Freescale/TARGET_K20D50M/serial_api.c@339:40bd4701f3e2, 2014-10-06 (annotated)

Committer:
mbed_official
Date:
Mon Oct 06 11:45:07 2014 +0100
Revision:
339:40bd4701f3e2
Parent:
255:20b371a9491b 
Synchronized with git revision 6d6dd0be3a7c63040d853cb4f5bfc1ba605a11bb



Full URL: https://github.com/mbedmicro/mbed/commit/6d6dd0be3a7c63040d853cb4f5bfc1ba605a11bb/



HAL: Allow Serial pin to be NC for all targets

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 255:20b371a9491b 1 /* mbed Microcontroller Library
mbed_official 255:20b371a9491b 2 * Copyright (c) 2006-2013 ARM Limited
mbed_official 255:20b371a9491b 3 *
mbed_official 255:20b371a9491b 4 * Licensed under the Apache License, Version 2.0 (the "License");
mbed_official 255:20b371a9491b 5 * you may not use this file except in compliance with the License.
mbed_official 255:20b371a9491b 6 * You may obtain a copy of the License at
mbed_official 255:20b371a9491b 7 *
mbed_official 255:20b371a9491b 8 * http://www.apache.org/licenses/LICENSE-2.0
mbed_official 255:20b371a9491b 9 *
mbed_official 255:20b371a9491b 10 * Unless required by applicable law or agreed to in writing, software
mbed_official 255:20b371a9491b 11 * distributed under the License is distributed on an "AS IS" BASIS,
mbed_official 255:20b371a9491b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbed_official 255:20b371a9491b 13 * See the License for the specific language governing permissions and
mbed_official 255:20b371a9491b 14 * limitations under the License.
mbed_official 255:20b371a9491b 15 */
mbed_official 255:20b371a9491b 16 #include "mbed_assert.h"
mbed_official 255:20b371a9491b 17 #include "serial_api.h"
mbed_official 255:20b371a9491b 18
mbed_official 255:20b371a9491b 19 // math.h required for floating point operations for baud rate calculation
mbed_official 255:20b371a9491b 20 #include <math.h>
mbed_official 255:20b371a9491b 21
mbed_official 255:20b371a9491b 22 #include <string.h>
mbed_official 255:20b371a9491b 23
mbed_official 255:20b371a9491b 24 #include "cmsis.h"
mbed_official 255:20b371a9491b 25 #include "pinmap.h"
mbed_official 255:20b371a9491b 26
mbed_official 255:20b371a9491b 27 static const PinMap PinMap_UART_TX[] = {
mbed_official 255:20b371a9491b 28 {PTB17, UART_0, 3},
mbed_official 255:20b371a9491b 29 {PTC4 , UART_1, 3},
mbed_official 255:20b371a9491b 30 {PTD3 , UART_2, 3},
mbed_official 255:20b371a9491b 31 {PTD7 , UART_0, 3},
mbed_official 255:20b371a9491b 32 {PTE0 , UART_1, 3},
mbed_official 255:20b371a9491b 33 {NC , NC , 0}
mbed_official 255:20b371a9491b 34 };
mbed_official 255:20b371a9491b 35
mbed_official 255:20b371a9491b 36 static const PinMap PinMap_UART_RX[] = {
mbed_official 255:20b371a9491b 37 {PTB16, UART_0, 3},
mbed_official 255:20b371a9491b 38 {PTC3 , UART_1, 3},
mbed_official 255:20b371a9491b 39 {PTD2 , UART_2, 3},
mbed_official 255:20b371a9491b 40 {PTD6 , UART_0, 3},
mbed_official 255:20b371a9491b 41 {PTE1 , UART_1, 3},
mbed_official 255:20b371a9491b 42 {NC , NC , 0}
mbed_official 255:20b371a9491b 43 };
mbed_official 255:20b371a9491b 44
mbed_official 255:20b371a9491b 45 #define UART_NUM 3
mbed_official 255:20b371a9491b 46
mbed_official 255:20b371a9491b 47 static uint32_t serial_irq_ids[UART_NUM] = {0};
mbed_official 255:20b371a9491b 48 static uart_irq_handler irq_handler;
mbed_official 255:20b371a9491b 49
mbed_official 255:20b371a9491b 50 int stdio_uart_inited = 0;
mbed_official 255:20b371a9491b 51 serial_t stdio_uart;
mbed_official 255:20b371a9491b 52
mbed_official 255:20b371a9491b 53 void serial_init(serial_t *obj, PinName tx, PinName rx) {
mbed_official 255:20b371a9491b 54 // determine the UART to use
mbed_official 255:20b371a9491b 55 UARTName uart_tx = (UARTName)pinmap_peripheral(tx, PinMap_UART_TX);
mbed_official 255:20b371a9491b 56 UARTName uart_rx = (UARTName)pinmap_peripheral(rx, PinMap_UART_RX);
mbed_official 255:20b371a9491b 57 UARTName uart = (UARTName)pinmap_merge(uart_tx, uart_rx);
mbed_official 255:20b371a9491b 58 MBED_ASSERT((int)uart != NC);
mbed_official 255:20b371a9491b 59
mbed_official 255:20b371a9491b 60 obj->uart = (UART_Type *)uart;
mbed_official 255:20b371a9491b 61 // enable clk
mbed_official 255:20b371a9491b 62 switch (uart) {
mbed_official 255:20b371a9491b 63 case UART_0:
mbed_official 255:20b371a9491b 64 SIM->SOPT2 |= SIM_SOPT2_PLLFLLSEL_MASK;
mbed_official 255:20b371a9491b 65 SIM->SCGC5 |= SIM_SCGC5_PORTA_MASK;
mbed_official 255:20b371a9491b 66 SIM->SCGC4 |= SIM_SCGC4_UART0_MASK;
mbed_official 255:20b371a9491b 67 break;
mbed_official 255:20b371a9491b 68 case UART_1:
mbed_official 255:20b371a9491b 69 SIM->SCGC5 |= SIM_SCGC5_PORTC_MASK;
mbed_official 255:20b371a9491b 70 SIM->SCGC4 |= SIM_SCGC4_UART1_MASK;
mbed_official 255:20b371a9491b 71 break;
mbed_official 255:20b371a9491b 72 case UART_2:
mbed_official 255:20b371a9491b 73 SIM->SCGC5 |= SIM_SCGC5_PORTD_MASK;
mbed_official 255:20b371a9491b 74 SIM->SCGC4 |= SIM_SCGC4_UART2_MASK;
mbed_official 255:20b371a9491b 75 break;
mbed_official 255:20b371a9491b 76 }
mbed_official 255:20b371a9491b 77 // Disable UART before changing registers
mbed_official 255:20b371a9491b 78 obj->uart->C2 &= ~(UART_C2_RE_MASK | UART_C2_TE_MASK);
mbed_official 255:20b371a9491b 79
mbed_official 255:20b371a9491b 80 switch (uart) {
mbed_official 255:20b371a9491b 81 case UART_0:
mbed_official 255:20b371a9491b 82 obj->index = 0;
mbed_official 255:20b371a9491b 83 break;
mbed_official 255:20b371a9491b 84 case UART_1:
mbed_official 255:20b371a9491b 85 obj->index = 1;
mbed_official 255:20b371a9491b 86 break;
mbed_official 255:20b371a9491b 87 case UART_2:
mbed_official 255:20b371a9491b 88 obj->index = 2;
mbed_official 255:20b371a9491b 89 break;
mbed_official 255:20b371a9491b 90 }
mbed_official 255:20b371a9491b 91
mbed_official 255:20b371a9491b 92 // set default baud rate and format
mbed_official 255:20b371a9491b 93 serial_baud (obj, 9600);
mbed_official 255:20b371a9491b 94 serial_format(obj, 8, ParityNone, 1);
mbed_official 255:20b371a9491b 95
mbed_official 255:20b371a9491b 96 // pinout the chosen uart
mbed_official 255:20b371a9491b 97 pinmap_pinout(tx, PinMap_UART_TX);
mbed_official 255:20b371a9491b 98 pinmap_pinout(rx, PinMap_UART_RX);
mbed_official 255:20b371a9491b 99
mbed_official 255:20b371a9491b 100 // set rx/tx pins in PullUp mode
mbed_official 339:40bd4701f3e2 101 if (tx != NC) {
mbed_official 339:40bd4701f3e2 102 pin_mode(tx, PullUp);
mbed_official 339:40bd4701f3e2 103 }
mbed_official 339:40bd4701f3e2 104 if (rx != NC) {
mbed_official 339:40bd4701f3e2 105 pin_mode(rx, PullUp);
mbed_official 339:40bd4701f3e2 106 }
mbed_official 255:20b371a9491b 107
mbed_official 255:20b371a9491b 108 obj->uart->C2 |= (UART_C2_RE_MASK | UART_C2_TE_MASK);
mbed_official 255:20b371a9491b 109
mbed_official 255:20b371a9491b 110 if (uart == STDIO_UART) {
mbed_official 255:20b371a9491b 111 stdio_uart_inited = 1;
mbed_official 255:20b371a9491b 112 memcpy(&stdio_uart, obj, sizeof(serial_t));
mbed_official 255:20b371a9491b 113 }
mbed_official 255:20b371a9491b 114 }
mbed_official 255:20b371a9491b 115
mbed_official 255:20b371a9491b 116 void serial_free(serial_t *obj) {
mbed_official 255:20b371a9491b 117 serial_irq_ids[obj->index] = 0;
mbed_official 255:20b371a9491b 118 }
mbed_official 255:20b371a9491b 119
mbed_official 255:20b371a9491b 120 void serial_baud(serial_t *obj, int baudrate) {
mbed_official 255:20b371a9491b 121 // save C2 state
mbed_official 255:20b371a9491b 122 uint32_t c2_state = (obj->uart->C2 & (UART_C2_RE_MASK | UART_C2_TE_MASK));
mbed_official 255:20b371a9491b 123
mbed_official 255:20b371a9491b 124 // Disable UART before changing registers
mbed_official 255:20b371a9491b 125 obj->uart->C2 &= ~(UART_C2_RE_MASK | UART_C2_TE_MASK);
mbed_official 255:20b371a9491b 126
mbed_official 255:20b371a9491b 127 uint32_t PCLK = (obj->uart == UART0) ? SystemCoreClock : SystemCoreClock/2;
mbed_official 255:20b371a9491b 128
mbed_official 255:20b371a9491b 129 // First we check to see if the basic divide with no DivAddVal/MulVal
mbed_official 255:20b371a9491b 130 // ratio gives us an integer result. If it does, we set DivAddVal = 0,
mbed_official 255:20b371a9491b 131 // MulVal = 1. Otherwise, we search the valid ratio value range to find
mbed_official 255:20b371a9491b 132 // the closest match. This could be more elegant, using search methods
mbed_official 255:20b371a9491b 133 // and/or lookup tables, but the brute force method is not that much
mbed_official 255:20b371a9491b 134 // slower, and is more maintainable.
mbed_official 255:20b371a9491b 135 uint16_t DL = PCLK / (16 * baudrate);
mbed_official 255:20b371a9491b 136
mbed_official 255:20b371a9491b 137 // set BDH and BDL
mbed_official 255:20b371a9491b 138 obj->uart->BDH = (obj->uart->BDH & ~(0x1f)) | ((DL >> 8) & 0x1f);
mbed_official 255:20b371a9491b 139 obj->uart->BDL = (obj->uart->BDL & ~(0xff)) | ((DL >> 0) & 0xff);
mbed_official 255:20b371a9491b 140
mbed_official 255:20b371a9491b 141 // restore C2 state
mbed_official 255:20b371a9491b 142 obj->uart->C2 |= c2_state;
mbed_official 255:20b371a9491b 143 }
mbed_official 255:20b371a9491b 144
mbed_official 255:20b371a9491b 145 void serial_format(serial_t *obj, int data_bits, SerialParity parity, int stop_bits) {
mbed_official 255:20b371a9491b 146 MBED_ASSERT((stop_bits == 1) || (stop_bits == 2));
mbed_official 255:20b371a9491b 147 MBED_ASSERT((parity == ParityNone) || (parity == ParityOdd) || (parity == ParityEven));
mbed_official 255:20b371a9491b 148 MBED_ASSERT((data_bits == 8) || (data_bits == 9));
mbed_official 255:20b371a9491b 149
mbed_official 255:20b371a9491b 150 // save C2 state
mbed_official 255:20b371a9491b 151 uint32_t c2_state = (obj->uart->C2 & (UART_C2_RE_MASK | UART_C2_TE_MASK));
mbed_official 255:20b371a9491b 152
mbed_official 255:20b371a9491b 153 // Disable UART before changing registers
mbed_official 255:20b371a9491b 154 obj->uart->C2 &= ~(UART_C2_RE_MASK | UART_C2_TE_MASK);
mbed_official 255:20b371a9491b 155
mbed_official 255:20b371a9491b 156 // 8 data bits = 0 ... 9 data bits = 1
mbed_official 255:20b371a9491b 157 data_bits -= 8;
mbed_official 255:20b371a9491b 158
mbed_official 255:20b371a9491b 159 uint32_t parity_enable, parity_select;
mbed_official 255:20b371a9491b 160 switch (parity) {
mbed_official 255:20b371a9491b 161 case ParityNone:
mbed_official 255:20b371a9491b 162 parity_enable = 0;
mbed_official 255:20b371a9491b 163 parity_select = 0;
mbed_official 255:20b371a9491b 164 break;
mbed_official 255:20b371a9491b 165 case ParityOdd :
mbed_official 255:20b371a9491b 166 parity_enable = 1;
mbed_official 255:20b371a9491b 167 parity_select = 1;
mbed_official 255:20b371a9491b 168 data_bits++;
mbed_official 255:20b371a9491b 169 break;
mbed_official 255:20b371a9491b 170 case ParityEven:
mbed_official 255:20b371a9491b 171 parity_enable = 1;
mbed_official 255:20b371a9491b 172 parity_select = 0;
mbed_official 255:20b371a9491b 173 data_bits++;
mbed_official 255:20b371a9491b 174 break;
mbed_official 255:20b371a9491b 175 default:
mbed_official 255:20b371a9491b 176 break;
mbed_official 255:20b371a9491b 177 }
mbed_official 255:20b371a9491b 178
mbed_official 255:20b371a9491b 179 stop_bits -= 1;
mbed_official 255:20b371a9491b 180
mbed_official 255:20b371a9491b 181 uint32_t m10 = 0;
mbed_official 255:20b371a9491b 182
mbed_official 255:20b371a9491b 183 // 9 data bits + parity - only uart0 support
mbed_official 255:20b371a9491b 184 if (data_bits == 2) {
mbed_official 255:20b371a9491b 185 MBED_ASSERT(obj->index == 0);
mbed_official 255:20b371a9491b 186 data_bits = 0;
mbed_official 255:20b371a9491b 187 m10 = 1;
mbed_official 255:20b371a9491b 188 }
mbed_official 255:20b371a9491b 189
mbed_official 255:20b371a9491b 190 // data bits, parity and parity mode
mbed_official 255:20b371a9491b 191 obj->uart->C1 = ((data_bits << 4)
mbed_official 255:20b371a9491b 192 | (parity_enable << 1)
mbed_official 255:20b371a9491b 193 | (parity_select << 0));
mbed_official 255:20b371a9491b 194
mbed_official 255:20b371a9491b 195 //enable 10bit mode if needed
mbed_official 255:20b371a9491b 196 if (obj->index == 0) {
mbed_official 255:20b371a9491b 197 obj->uart->C4 &= ~UART_C4_M10_MASK;
mbed_official 255:20b371a9491b 198 obj->uart->C4 |= (m10 << UART_C4_M10_SHIFT);
mbed_official 255:20b371a9491b 199 }
mbed_official 255:20b371a9491b 200
mbed_official 255:20b371a9491b 201 // stop bits
mbed_official 255:20b371a9491b 202 obj->uart->BDH &= ~UART_BDH_SBR_MASK;
mbed_official 255:20b371a9491b 203 obj->uart->BDH |= (stop_bits << UART_BDH_SBR_SHIFT);
mbed_official 255:20b371a9491b 204
mbed_official 255:20b371a9491b 205 // restore C2 state
mbed_official 255:20b371a9491b 206 obj->uart->C2 |= c2_state;
mbed_official 255:20b371a9491b 207 }
mbed_official 255:20b371a9491b 208
mbed_official 255:20b371a9491b 209 /******************************************************************************
mbed_official 255:20b371a9491b 210 * INTERRUPTS HANDLING
mbed_official 255:20b371a9491b 211 ******************************************************************************/
mbed_official 255:20b371a9491b 212 static inline void uart_irq(uint8_t status, uint32_t index) {
mbed_official 255:20b371a9491b 213 if (serial_irq_ids[index] != 0) {
mbed_official 255:20b371a9491b 214 if (status & UART_S1_TDRE_MASK)
mbed_official 255:20b371a9491b 215 irq_handler(serial_irq_ids[index], TxIrq);
mbed_official 255:20b371a9491b 216
mbed_official 255:20b371a9491b 217 if (status & UART_S1_RDRF_MASK)
mbed_official 255:20b371a9491b 218 irq_handler(serial_irq_ids[index], RxIrq);
mbed_official 255:20b371a9491b 219 }
mbed_official 255:20b371a9491b 220 }
mbed_official 255:20b371a9491b 221
mbed_official 255:20b371a9491b 222 void uart0_irq() {uart_irq(UART0->S1, 0);}
mbed_official 255:20b371a9491b 223 void uart1_irq() {uart_irq(UART1->S1, 1);}
mbed_official 255:20b371a9491b 224 void uart2_irq() {uart_irq(UART2->S1, 2);}
mbed_official 255:20b371a9491b 225
mbed_official 255:20b371a9491b 226 void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id) {
mbed_official 255:20b371a9491b 227 irq_handler = handler;
mbed_official 255:20b371a9491b 228 serial_irq_ids[obj->index] = id;
mbed_official 255:20b371a9491b 229 }
mbed_official 255:20b371a9491b 230
mbed_official 255:20b371a9491b 231 void serial_irq_set(serial_t *obj, SerialIrq irq, uint32_t enable) {
mbed_official 255:20b371a9491b 232 IRQn_Type irq_n = (IRQn_Type)0;
mbed_official 255:20b371a9491b 233 uint32_t vector = 0;
mbed_official 255:20b371a9491b 234 switch ((int)obj->uart) {
mbed_official 255:20b371a9491b 235 case UART_0:
mbed_official 255:20b371a9491b 236 irq_n=UART0_RX_TX_IRQn;
mbed_official 255:20b371a9491b 237 vector = (uint32_t)&uart0_irq;
mbed_official 255:20b371a9491b 238 break;
mbed_official 255:20b371a9491b 239 case UART_1:
mbed_official 255:20b371a9491b 240 irq_n=UART1_RX_TX_IRQn;
mbed_official 255:20b371a9491b 241 vector = (uint32_t)&uart1_irq;
mbed_official 255:20b371a9491b 242 break;
mbed_official 255:20b371a9491b 243 case UART_2:
mbed_official 255:20b371a9491b 244 irq_n=UART2_RX_TX_IRQn;
mbed_official 255:20b371a9491b 245 vector = (uint32_t)&uart2_irq;
mbed_official 255:20b371a9491b 246 break;
mbed_official 255:20b371a9491b 247 }
mbed_official 255:20b371a9491b 248
mbed_official 255:20b371a9491b 249 if (enable) {
mbed_official 255:20b371a9491b 250 switch (irq) {
mbed_official 255:20b371a9491b 251 case RxIrq:
mbed_official 255:20b371a9491b 252 obj->uart->C2 |= (UART_C2_RIE_MASK);
mbed_official 255:20b371a9491b 253 break;
mbed_official 255:20b371a9491b 254 case TxIrq:
mbed_official 255:20b371a9491b 255 obj->uart->C2 |= (UART_C2_TIE_MASK);
mbed_official 255:20b371a9491b 256 break;
mbed_official 255:20b371a9491b 257 }
mbed_official 255:20b371a9491b 258 NVIC_SetVector(irq_n, vector);
mbed_official 255:20b371a9491b 259 NVIC_EnableIRQ(irq_n);
mbed_official 255:20b371a9491b 260
mbed_official 255:20b371a9491b 261 } else { // disable
mbed_official 255:20b371a9491b 262 int all_disabled = 0;
mbed_official 255:20b371a9491b 263 SerialIrq other_irq = (irq == RxIrq) ? (TxIrq) : (RxIrq);
mbed_official 255:20b371a9491b 264 switch (irq) {
mbed_official 255:20b371a9491b 265 case RxIrq:
mbed_official 255:20b371a9491b 266 obj->uart->C2 &= ~(UART_C2_RIE_MASK);
mbed_official 255:20b371a9491b 267 break;
mbed_official 255:20b371a9491b 268 case TxIrq:
mbed_official 255:20b371a9491b 269 obj->uart->C2 &= ~(UART_C2_TIE_MASK);
mbed_official 255:20b371a9491b 270 break;
mbed_official 255:20b371a9491b 271 }
mbed_official 255:20b371a9491b 272 switch (other_irq) {
mbed_official 255:20b371a9491b 273 case RxIrq:
mbed_official 255:20b371a9491b 274 all_disabled = (obj->uart->C2 & (UART_C2_RIE_MASK)) == 0;
mbed_official 255:20b371a9491b 275 break;
mbed_official 255:20b371a9491b 276 case TxIrq:
mbed_official 255:20b371a9491b 277 all_disabled = (obj->uart->C2 & (UART_C2_TIE_MASK)) == 0;
mbed_official 255:20b371a9491b 278 break;
mbed_official 255:20b371a9491b 279 }
mbed_official 255:20b371a9491b 280 if (all_disabled)
mbed_official 255:20b371a9491b 281 NVIC_DisableIRQ(irq_n);
mbed_official 255:20b371a9491b 282 }
mbed_official 255:20b371a9491b 283 }
mbed_official 255:20b371a9491b 284
mbed_official 255:20b371a9491b 285 int serial_getc(serial_t *obj) {
mbed_official 255:20b371a9491b 286 while (!serial_readable(obj));
mbed_official 255:20b371a9491b 287 return obj->uart->D;
mbed_official 255:20b371a9491b 288 }
mbed_official 255:20b371a9491b 289
mbed_official 255:20b371a9491b 290 void serial_putc(serial_t *obj, int c) {
mbed_official 255:20b371a9491b 291 while (!serial_writable(obj));
mbed_official 255:20b371a9491b 292 obj->uart->D = c;
mbed_official 255:20b371a9491b 293 }
mbed_official 255:20b371a9491b 294
mbed_official 255:20b371a9491b 295 int serial_readable(serial_t *obj) {
mbed_official 255:20b371a9491b 296
mbed_official 255:20b371a9491b 297 return (obj->uart->S1 & UART_S1_RDRF_MASK);
mbed_official 255:20b371a9491b 298 }
mbed_official 255:20b371a9491b 299
mbed_official 255:20b371a9491b 300 int serial_writable(serial_t *obj) {
mbed_official 255:20b371a9491b 301
mbed_official 255:20b371a9491b 302 return (obj->uart->S1 & UART_S1_TDRE_MASK);
mbed_official 255:20b371a9491b 303 }
mbed_official 255:20b371a9491b 304
mbed_official 255:20b371a9491b 305 void serial_clear(serial_t *obj) {
mbed_official 255:20b371a9491b 306 }
mbed_official 255:20b371a9491b 307
mbed_official 255:20b371a9491b 308 void serial_pinout_tx(PinName tx) {
mbed_official 255:20b371a9491b 309 pinmap_pinout(tx, PinMap_UART_TX);
mbed_official 255:20b371a9491b 310 }
mbed_official 255:20b371a9491b 311
mbed_official 255:20b371a9491b 312 void serial_break_set(serial_t *obj) {
mbed_official 255:20b371a9491b 313 obj->uart->C2 |= UART_C2_SBK_MASK;
mbed_official 255:20b371a9491b 314 }
mbed_official 255:20b371a9491b 315
mbed_official 255:20b371a9491b 316 void serial_break_clear(serial_t *obj) {
mbed_official 255:20b371a9491b 317 obj->uart->C2 &= ~UART_C2_SBK_MASK;
mbed_official 255:20b371a9491b 318 }
mbed_official 255:20b371a9491b 319