mcid.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------- */
/*                  Atmel Microcontroller Software Support                      */
/*                       SAM Software Package License                           */
/* ---------------------------------------------------------------------------- */
/* Copyright (c) 2015, Atmel Corporation                                        */
/*                                                                              */
/* All rights reserved.                                                         */
/*                                                                              */
/* Redistribution and use in source and binary forms, with or without           */
/* modification, are permitted provided that the following condition is met:    */
/*                                                                              */
/* - Redistributions of source code must retain the above copyright notice,     */
/* this list of conditions and the disclaimer below.                            */
/*                                                                              */
/* Atmel's name may not be used to endorse or promote products derived from     */
/* this software without specific prior written permission.                     */
/*                                                                              */
/* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
/* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
/* DISCLAIMED. IN NO EVENT SHALL ATMEL 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.                           */
/* ---------------------------------------------------------------------------- */

#ifndef MCID_H
#define MCID_H

/*----------------------------------------------------------------------------
 *         Headers
 *----------------------------------------------------------------------------*/

#include "chip.h"

#include <stdint.h>
#include <stdio.h>

/*----------------------------------------------------------------------------
 *         Constants
 *----------------------------------------------------------------------------*/

#define MCID_IDLE   0       
#define MCID_LOCKED 1       
#define MCID_CMD    2       
#define MCID_ERROR  3       
#define MCI_INITIAL_SPEED   400000

/*----------------------------------------------------------------------------
 *         Types
 *----------------------------------------------------------------------------*/
#ifdef __cplusplus
extern "C" {
#endif

typedef struct _Mcid {
    Hsmci         *pMciHw;
    sXdmad         *pXdmad;
    void          *pCmd;
    uint32_t       dwMck;
    uint32_t       dwDmaCh;
    uint32_t       dwXfrNdx;
    uint32_t       dwXSize;
    uint8_t        bID;
    uint8_t        bPolling;
    uint8_t        reserved;
    volatile uint8_t bState;
} sMcid;

/*----------------------------------------------------------------------------
 *         Exported functions
 *----------------------------------------------------------------------------*/
extern void MCID_Init(sMcid *pMcid,
                      Hsmci *pMci, uint8_t bID, uint32_t dwMck,
                      sXdmad *pXdmad,
                      uint8_t bPolling);

extern void MCID_Reset(sMcid *pMcid);

extern void MCID_SetSlot(Hsmci *pMci, uint8_t slot);

extern uint32_t MCID_Lock(sMcid *pMcid, uint8_t bSlot);

extern uint32_t MCID_Release(sMcid *pMcid);

extern void MCID_Handler(sMcid *pMcid);

extern uint32_t MCID_SendCmd(sMcid *pMcid, void *pCmd);

extern uint32_t MCID_CancelCmd(sMcid *pMcid);

extern uint32_t MCID_IsCmdCompleted(sMcid *pMcid);

extern uint32_t MCID_IOCtrl(sMcid *pMcid, uint32_t bCtl, uint32_t param);

#ifdef __cplusplus
}
#endif

#endif //#ifndef HSMCID_H