/*********************************************************************
 *
 *                  SPI API implementation file
 *
 *********************************************************************
 * FileName:        spi_chn_get_rov_lib.c
 * Dependencies:	Generic.h
 * 					Spi.h
 *
 * Processor:       PIC32
 *
 * Complier:        MPLAB C32
 *                  MPLAB IDE
 * Company:         Microchip Technology Inc..
 *
 * Software License Agreement
 *
 * The software supplied herewith by Microchip Technology Incorporated
 * (the Company) for its PIC32 Microcontroller is intended
 * and supplied to you, the Companys customer, for use solely and
 * exclusively on Microchip PIC32 Microcontroller products.
 * The software is owned by the Company and/or its supplier, and is
 * protected under applicable copyright laws. All rights are reserved.
 * Any use in violation of the foregoing restrictions may subject the
 * user to criminal sanctions under applicable laws, as well as to
 * civil liability for the breach of the terms and conditions of this
 * license.
 *
 * THIS SOFTWARE IS PROVIDED IN AN AS IS CONDITION. NO WARRANTIES,
 * WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED
 * TO, IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE COMPANY SHALL NOT,
 * IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *
 * $Id$
 * $Name$
 *
 ********************************************************************/
#include <peripheral/generic.h>
#include <peripheral/spi.h>

#include "_spi_map_tbl.h"


/********************
 * Channel functions.
 * Defined only if there's at least one valid SPI channel
 * *********************************/
#if defined(_SPI1) || defined(_SPI2)

/*********************************************************************
 * Function:        int SpiChnGetRov(int chn, int clear)
 *
 * PreCondition:    None
 * Input:			chn			- the channel to check
 *					clear		- if TRUE, the overflow condition has to be cleared, if present
 * Output:          TRUE		- if overflow
 * 					FALSE		otherwise
 * Side Effects:    None
 * Overview:        This function reads the SPI channel overflow condition and clears it, if required.
 * Note:            None
 ********************************************************************/
PUBLIC int SpiChnGetRov(int chn, int clear)
{

	if(SpiMapTbl[chn-1]->stat.SPIROV)
	{
		if(clear)
		{
			SpiMapTbl[chn-1]->statClr=_SPI1STAT_SPIROV_MASK;
			// TODO: clear the event flag too?
		}
		return TRUE;
	}
	return FALSE;
}

#endif	//_SPI1 || _SPI2


