/* ChibiOS - Copyright (C) 2006..2015 Giovanni Di Sirio Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ /** * @file uart.c * @brief UART Driver code. * * @addtogroup UART * @{ */ #include "hal.h" #if (HAL_USE_UART == TRUE) || defined(__DOXYGEN__) /*===========================================================================*/ /* Driver local definitions. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver exported variables. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver local variables and types. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver local functions. */ /*===========================================================================*/ /*===========================================================================*/ /* Driver exported functions. */ /*===========================================================================*/ /** * @brief UART Driver initialization. * @note This function is implicitly invoked by @p halInit(), there is * no need to explicitly initialize the driver. * * @init */ void uartInit(void) { uart_lld_init(); } /** * @brief Initializes the standard part of a @p UARTDriver structure. * * @param[out] uartp pointer to the @p UARTDriver object * * @init */ void uartObjectInit(UARTDriver *uartp) { uartp->state = UART_STOP; uartp->txstate = UART_TX_IDLE; uartp->rxstate = UART_RX_IDLE; uartp->config = NULL; /* Optional, user-defined initializer.*/ #if defined(UART_DRIVER_EXT_INIT_HOOK) UART_DRIVER_EXT_INIT_HOOK(uartp); #endif } /** * @brief Configures and activates the UART peripheral. * * @param[in] uartp pointer to the @p UARTDriver object * @param[in] config pointer to the @p UARTConfig object * * @api */ void uartStart(UARTDriver *uartp, const UARTConfig *config) { osalDbgCheck((uartp != NULL) && (config != NULL)); osalSysLock(); osalDbgAssert((uartp->state == UART_STOP) || (uartp->state == UART_READY), "invalid state"); uartp->config = config; uart_lld_start(uartp); uartp->state = UART_READY; osalSysUnlock(); } /** * @brief Deactivates the UART peripheral. * * @param[in] uartp pointer to the @p UARTDriver object * * @api */ void uartStop(UARTDriver *uartp) { osalDbgCheck(uartp != NULL); osalSysLock(); osalDbgAssert((uartp->state == UART_STOP) || (uartp->state == UART_READY), "invalid state"); uart_lld_stop(uartp); uartp->state = UART_STOP; uartp->txstate = UART_TX_IDLE; uartp->rxstate = UART_RX_IDLE; osalSysUnlock(); } /** * @brief Starts a transmission on the UART peripheral. * @note The buffers are organized as uint8_t arrays for data sizes below * or equal to 8 bits else it is organized as uint16_t arrays. * * @param[in] uartp pointer to the @p UARTDriver object * @param[in] n number of data frames to send * @param[in] txbuf the pointer to the transmit buffer * * @api */ void uartStartSend(UARTDriver *uartp, size_t n, const void *txbuf) { osalDbgCheck((uartp != NULL) && (n > 0U) && (txbuf != NULL)); osalSysLock(); osalDbgAssert(uartp->state == UART_READY, "is active"); osalDbgAssert(uartp->txstate != UART_TX_ACTIVE, "tx active"); uart_lld_start_send(uartp, n, txbuf); uartp->txstate = UART_TX_ACTIVE; osalSysUnlock(); } /** * @brief Starts a transmission on the UART peripheral. * @note The buffers are organized as uint8_t arrays for data sizes below * or equal to 8 bits else it is organized as uint16_t arrays. * @note This function has to be invoked from a lock zone. * * @param[in] uartp pointer to the @p UARTDriver object * @param[in] n number of data frames to send * @param[in] txbuf the pointer to the transmit buffer * * @iclass */ void uartStartSendI(UARTDriver *uartp, size_t n, const void *txbuf) { osalDbgCheckClassI(); osalDbgCheck((uartp != NULL) && (n > 0U) && (txbuf != NULL)); osalDbgAssert(uartp->state == UART_READY, "is active"); osalDbgAssert(uartp->txstate != UART_TX_ACTIVE, "tx active"); uart_lld_start_send(uartp, n, txbuf); uartp->txstate = UART_TX_ACTIVE; } /** * @brief Stops any ongoing transmission. * @note Stopping a transmission also suppresses the transmission callbacks. * * @param[in] uartp pointer to the @p UARTDriver object * * @return The number of data frames not transmitted by the * stopped transmit operation. * @retval 0 There was no transmit operation in progress. * * @api */ size_t uartStopSend(UARTDriver *uartp) { size_t n; osalDbgCheck(uartp != NULL); osalSysLock(); osalDbgAssert(uartp->state == UART_READY, "not active"); if (uartp->txstate == UART_TX_ACTIVE) { n = uart_lld_stop_send(uartp); uartp->txstate = UART_TX_IDLE; } else { n = 0; } osalSysUnlock(); return n; } /** * @brief Stops any ongoing transmission. * @note Stopping a transmission also suppresses the transmission callbacks. * @note This function has to be invoked from a lock zone. * * @param[in] uartp pointer to the @p UARTDriver object * * @return The number of data frames not transmitted by the * stopped transmit operation. * @retval 0 There was no transmit operation in progress. * * @iclass */ size_t uartStopSendI(UARTDriver *uartp) { osalDbgCheckClassI(); osalDbgCheck(uartp != NULL); osalDbgAssert(uartp->state == UART_READY, "not active"); if (uartp->txstate == UART_TX_ACTIVE) { size_t n = uart_lld_stop_send(uartp); uartp->txstate = UART_TX_IDLE; return n; } return 0; } /** * @brief Starts a receive operation on the UART peripheral. * @note The buffers are organized as uint8_t arrays for data sizes below * or equal to 8 bits else it is organized as uint16_t arrays. * * @param[in] uartp pointer to the @p UARTDriver object * @param[in] n number of data frames to send * @param[in] rxbuf the pointer to the receive buffer * * @api */ void uartStartReceive(UARTDriver *uartp, size_t n, void *rxbuf) { osalDbgCheck((uartp != NULL) && (n > 0U) && (rxbuf != NULL)); osalSysLock(); osalDbgAssert(uartp->state == UART_READY, "is active"); osalDbgAssert(uartp->rxstate != UART_RX_ACTIVE, "rx active"); uart_lld_start_receive(uartp, n, rxbuf); uartp->rxstate = UART_RX_ACTIVE; osalSysUnlock(); } /** * @brief Starts a receive operation on the UART peripheral. * @note The buffers are organized as uint8_t arrays for data sizes below * or equal to 8 bits else it is organized as uint16_t arrays. * @note This function has to be invoked from a lock zone. * * @param[in] uartp pointer to the @p UARTDriver object * @param[in] n number of data frames to send * @param[out] rxbuf the pointer to the receive buffer * * @iclass */ void uartStartReceiveI(UARTDriver *uartp, size_t n, void *rxbuf) { osalDbgCheckClassI(); osalDbgCheck((uartp != NULL) && (n > 0U) && (rxbuf != NULL)); osalDbgAssert(uartp->state == UART_READY, "is active"); osalDbgAssert(uartp->rxstate != UART_RX_ACTIVE, "rx active"); uart_lld_start_receive(uartp, n, rxbuf); uartp->rxstate = UART_RX_ACTIVE; } /** * @brief Stops any ongoing receive operation. * @note Stopping a receive operation also suppresses the receive callbacks. * * @param[in] uartp pointer to the @p UARTDriver object * * @return The number of data frames not received by the * stopped receive operation. * @retval 0 There was no receive operation in progress. * * @api */ size_t uartStopReceive(UARTDriver *uartp) { size_t n; osalDbgCheck(uartp != NULL); osalSysLock(); osalDbgAssert(uartp->state == UART_READY, "not active"); if (uartp->rxstate == UART_RX_ACTIVE) { n = uart_lld_stop_receive(uartp); uartp->rxstate = UART_RX_IDLE; } else { n = 0; } osalSysUnlock(); return n; } /** * @brief Stops any ongoing receive operation. * @note Stopping a receive operation also suppresses the receive callbacks. * @note This function has to be invoked from a lock zone. * * @param[in] uartp pointer to the @p UARTDriver object * * @return The number of data frames not received by the * stopped receive operation. * @retval 0 There was no receive operation in progress. * * @iclass */ size_t uartStopReceiveI(UARTDriver *uartp) { osalDbgCheckClassI(); osalDbgCheck(uartp != NULL); osalDbgAssert(uartp->state == UART_READY, "not active"); if (uartp->rxstate == UART_RX_ACTIVE) { size_t n = uart_lld_stop_receive(uartp); uartp->rxstate = UART_RX_IDLE; return n; } return 0; } #endif /* HAL_USE_UART == TRUE */ /** @} */ 16' href='#n216'>216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633