/*******************************************************************************
  BMX Peripheral Library Template Implementation

  File Name:
    bmx_DataRAMPartition_Default.h

  Summary:
    BMX PLIB Template Implementation

  Description:
    This header file contains template implementations
    For Feature : DataRAMPartition
    and its Variant : Default
    For following APIs :
        PLIB_BMX_ExistsDataRAMPartition
        PLIB_BMX_DataRAMPartitionSet
        PLIB_BMX_DataRAMKernelProgramOffsetGet
        PLIB_BMX_DataRAMUserDataOffsetGet
        PLIB_BMX_DataRAMUserProgramOffsetGet

*******************************************************************************/

//DOM-IGNORE-BEGIN
/*******************************************************************************
Copyright (c) 2012 released Microchip Technology Inc.  All rights reserved.

Microchip licenses to you the right to use, modify, copy and distribute
Software only when embedded on a Microchip microcontroller or digital signal
controller that is integrated into your product or third party product
(pursuant to the sublicense terms in the accompanying license agreement).

You should refer to the license agreement accompanying this Software for
additional information regarding your rights and obligations.

SOFTWARE AND DOCUMENTATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF
MERCHANTABILITY, TITLE, NON-INFRINGEMENT AND FITNESS FOR A PARTICULAR PURPOSE.
IN NO EVENT SHALL MICROCHIP OR ITS LICENSORS BE LIABLE OR OBLIGATED UNDER
CONTRACT, NEGLIGENCE, STRICT LIABILITY, CONTRIBUTION, BREACH OF WARRANTY, OR
OTHER LEGAL EQUITABLE THEORY ANY DIRECT OR INDIRECT DAMAGES OR EXPENSES
INCLUDING BUT NOT LIMITED TO ANY INCIDENTAL, SPECIAL, INDIRECT, PUNITIVE OR
CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA, COST OF PROCUREMENT OF
SUBSTITUTE GOODS, TECHNOLOGY, SERVICES, OR ANY CLAIMS BY THIRD PARTIES
(INCLUDING BUT NOT LIMITED TO ANY DEFENSE THEREOF), OR OTHER SIMILAR COSTS.
*******************************************************************************/

//DOM-IGNORE-END

#ifndef _BMX_DATARAMPARTITION_DEFAULT_H
#define _BMX_DATARAMPARTITION_DEFAULT_H

#include "bmx_registers.h"

//******************************************************************************
/* Function :  BMX_ExistsDataRAMPartition_Default

  Summary:
    Implements Default variant of PLIB_BMX_ExistsDataRAMPartition

  Description:
    This template implements the Default variant of the PLIB_BMX_ExistsDataRAMPartition function.
*/

#define PLIB_BMX_ExistsDataRAMPartition PLIB_BMX_ExistsDataRAMPartition
PLIB_TEMPLATE bool BMX_ExistsDataRAMPartition_Default( BMX_MODULE_ID index )
{
    return true;
}


//******************************************************************************
/* Function :  BMX_DataRAMPartitionSet_Default

  Summary:
    Implements Default variant of PLIB_BMX_DataRAMPartitionSet 

  Description:
    This template implements the Default variant of the PLIB_BMX_DataRAMPartitionSet function.
*/

PLIB_TEMPLATE void BMX_DataRAMPartitionSet_Default( BMX_MODULE_ID index , size_t kernProgOffset , size_t userDataOffset , size_t userProgOffset )
{
    volatile bmx_register_t *bmx = (bmx_register_t *)index;

    bmx->BMXDKPBA = kernProgOffset;
    bmx->BMXDUDBA = userDataOffset;
    bmx->BMXDUPBA = userProgOffset;
}


//******************************************************************************
/* Function :  BMX_DataRAMKernelProgramOffsetGet_Default

  Summary:
    Implements Default variant of PLIB_BMX_DataRAMKernelProgramOffsetGet 

  Description:
    This template implements the Default variant of the PLIB_BMX_DataRAMKernelProgramOffsetGet function.
*/

PLIB_TEMPLATE size_t BMX_DataRAMKernelProgramOffsetGet_Default( BMX_MODULE_ID index )
{
    volatile bmx_register_t *bmx = (bmx_register_t *)index;

    return (size_t)bmx->BMXDKPBA;
}


//******************************************************************************
/* Function :  BMX_DataRAMUserDataOffsetGet_Default

  Summary:
    Implements Default variant of PLIB_BMX_DataRAMUserDataOffsetGet 

  Description:
    This template implements the Default variant of the PLIB_BMX_DataRAMUserDataOffsetGet function.
*/

PLIB_TEMPLATE size_t BMX_DataRAMUserDataOffsetGet_Default( BMX_MODULE_ID index )
{
    volatile bmx_register_t *bmx = (bmx_register_t *)index;

    return (size_t)bmx->BMXDUDBA;
}


//******************************************************************************
/* Function :  BMX_DataRAMUserProgramOffsetGet_Default

  Summary:
    Implements Default variant of PLIB_BMX_DataRAMUserProgramOffsetGet 

  Description:
    This template implements the Default variant of the PLIB_BMX_DataRAMUserProgramOffsetGet function.
*/

PLIB_TEMPLATE size_t BMX_DataRAMUserProgramOffsetGet_Default( BMX_MODULE_ID index )
{
    volatile bmx_register_t *bmx = (bmx_register_t *)index;

    return (size_t)bmx->BMXDUPBA;
}


#endif /*_BMX_DATARAMPARTITION_DEFAULT_H*/

/******************************************************************************
 End of File
*/

