d_usartDMA.h

Go to the documentation of this file.

/*
MIT LICENSE

Copyright 2014-2019 Inertial Sense, Inc. - http://inertialsense.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files(the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions :

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT, IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

#ifndef _D_USARTDMA_H_
#define _D_USARTDMA_H_

#ifdef __cplusplus
extern "C" {
#endif

#include "../ASF/sam/drivers/usart/usart.h"
#include "conf_d_usartDMA.h"

typedef struct
{
        uint32_t                timeMsLast;
        uint32_t                txByteCount;
        uint32_t                rxByteCount;
        uint32_t                txBytesPerS;
        uint32_t                rxBytesPerS;
        uint32_t                status;
} port_monitor_helper_t;

extern port_monitor_helper_t g_portMonitorHelper[MAX_NUMBER_SERIAL_PORTS];


//_____ P R O T O T Y P E S ________________________________________________

bool d_usartDMA_callback_cdc_enable(void);
void d_usartDMA_callback_cdc_disable(void);
void d_usartDMA_callback_cdc_tx_empty_notify(void);

int serWrite( int serialNum, const unsigned char *buf, int size );

// Buffer overrun can be detected when serRxUsed decreases outside of a serRead(), because
// the Rx PDCA (DMA) wrote past the read pointer.
int serRead( int serialNum, unsigned char *buf, int size );

int serRxClear( int serialNum, int len );

int serRxUsed( int serialNum );

int serTxClear( int serialNum );

int serTxUsed( int serialNum );

int serRxFree( int serialNum );

int serTxFree( int serialNum );

int serFindCharacter( int serialNum, uint8_t ch);

int validateBaudRate(unsigned int baudRate);

int serSetBaudRate( int serialNum, int baudrate );

int serGetBaudRate( int serialNum );

int serInit( int serialNum, uint32_t baudRate, sam_usart_opt_t *options, uint32_t* overrunStatus );

#ifdef __cplusplus
}
#endif

#endif  // _D_USARTDMA_H_