stm32f7xx_hal_smartcard.c File Reference

SMARTCARD HAL module driver. This file provides firmware functions to manage the following functionalities of the SMARTCARD peripheral: More...

#include "stm32f7xx_hal.h"

Go to the source code of this file.

Detailed Description

SMARTCARD HAL module driver. This file provides firmware functions to manage the following functionalities of the SMARTCARD peripheral:

Author

MCD Application Team

Version

V1.1.0

Date

22-April-2016

• Initialization and de-initialization functions
• IO operation functions
• Peripheral State and Errors functions

==============================================================================
                   ##### How to use this driver #####
==============================================================================
[..]
  The SMARTCARD HAL driver can be used as follow:
  
  (#) Declare a SMARTCARD_HandleTypeDef handle structure.
  (#) Associate a USART to the SMARTCARD handle hsc.
  (#) Initialize the SMARTCARD low level resources by implementing the HAL_SMARTCARD_MspInit() API:
      (##) Enable the USARTx interface clock.
      (##) SMARTCARD pins configuration:
          (+++) Enable the clock for the SMARTCARD GPIOs.
          (+++) Configure these SMARTCARD pins as alternate function pull-up.
      (##) NVIC configuration if you need to use interrupt process (HAL_SMARTCARD_Transmit_IT()
           and HAL_SMARTCARD_Receive_IT() APIs):
          (+++) Configure the USARTx interrupt priority.
          (+++) Enable the NVIC USART IRQ handle.
          (+++) The specific USART interrupts (Transmission complete interrupt, 
                RXNE interrupt and Error Interrupts) will be managed using the macros
                __HAL_SMARTCARD_ENABLE_IT() and __HAL_SMARTCARD_DISABLE_IT() inside the transmit and receive process.
      (##) DMA Configuration if you need to use DMA process (HAL_SMARTCARD_Transmit_DMA()
           and HAL_SMARTCARD_Receive_DMA() APIs):
          (+++) Declare a DMA handle structure for the Tx/Rx stream.
          (+++) Enable the DMAx interface clock.
          (+++) Configure the declared DMA handle structure with the required Tx/Rx parameters.                
          (+++) Configure the DMA Tx/Rx Stream.
          (+++) Associate the initialized DMA handle to the SMARTCARD DMA Tx/Rx handle.
          (+++) Configure the priority and enable the NVIC for the transfer complete interrupt on the DMA Tx/Rx Stream.

  (#) Program the Baud Rate, Parity, Mode(Receiver/Transmitter), clock enabling/disabling and accordingly,
      the clock parameters (parity, phase, last bit), prescaler value, guard time and NACK on transmission
      error enabling or disabling in the hsc Init structure.
      
  (#) If required, program SMARTCARD advanced features (TX/RX pins swap, TimeOut, auto-retry counter,...)
      in the hsc AdvancedInit structure.

  (#) Initialize the SMARTCARD associated USART registers by calling
      the HAL_SMARTCARD_Init() API. 
  
[..]
  (@) HAL_SMARTCARD_Init() API also configure also the low level Hardware GPIO, CLOCK, CORTEX...etc) by 
      calling the customized HAL_SMARTCARD_MspInit() API.

Attention

© COPYRIGHT(c) 2016 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f7xx_hal_smartcard.c.