/*****************************************************************************/
/*                                             COPYRIGHT (c) FREESCALE 20005 */ 
/* File Name          :    $RCSfile: S12SPIV3.h,v $                          */
/*                                                                           */
/* Current Revision :      $Revision: 1.0 $                                  */
/*                                                                           */
/* PURPOSE: header file for HCS12 SPI register block                         */
/*                                                                           */
/*  ***********************************************************************  */
/*  *  THIS CODE IS ONLY INTENDED AS AN EXAMPLE OF CODE FOR THE           *  */
/*  *  METROWERKS COMPILER AND THE S12 EVB AND HAS ONLY BEEN GIVEN A      *  */
/*  *  MIMIMUM LEVEL OF TEST. IT IS PROVIDED 'AS SEEN' WITH NO GUARANTEES *  */
/*  *  AND NO PROMISE OF SUPPORT.                                         *  */
/*  ***********************************************************************  */
/*                                                                           */
/* DESCRIPTION:  Defines the SPI register block as a datastructure           */
/*               of type tSPI.                                               */
/*                                                                           */
/* UPDATE HISTORY                                                            */
/* REV  AUTHOR     DATE       DESCRIPTION OF CHANGE                          */
/* ---  ------    --------    ---------------------                          */
/* 1.00  r32151   2002        Intial coding based on s12_spi.h.              */
/* 1.01  R32151   24/05/02    Changed SPIDR type to tREG08.                  */
/*                                                                           */
/*===========================================================================*/
/* Freescale reserves the right to make changes without further notice to any*/
/* product herein to improve reliability, function, or design. Freescale does*/
/* not assume any  liability arising  out  of the  application or use of any */
/* product,  circuit, or software described herein;  neither  does it convey */
/* any license under its patent rights  nor the  rights of others.  Freescale*/
/* products are not designed, intended,  or authorized for use as components */
/* in  systems  intended  for  surgical  implant  into  the  body, or  other */
/* applications intended to support life, or  for any  other application  in */
/* which the failure of the Freescale product  could create a situation where*/
/* personal injury or death may occur. Should Buyer purchase or use Freescale*/
/* products for any such intended  or unauthorized  application, Buyer shall */
/* indemnify and  hold  Freescale  and its officers, employees, subsidiaries,*/
/* affiliates,  and distributors harmless against all claims costs, damages, */
/* and expenses, and reasonable  attorney  fees arising  out of, directly or */
/* indirectly,  any claim of personal injury  or death  associated with such */
/* unintended or unauthorized use, even if such claim alleges that  Freescale*/
/* was negligent regarding the  design  or manufacture of the part. Freescale*/
/* and the Freescale logo* are registered trademarks of Freescale Ltd.       */
/*****************************************************************************/


#ifndef S12SPIV4_H         /*prevent duplicated includes */
#define S12SPIV4_H

#ifndef S12_COMMON_H       /*prevent duplicated includes */
#include "s12_common.h"
#endif

typedef union uSPICR1
  {
  tU08   byte;
  struct
    {
    tU08 lsbfe :1;      /*lsb first enable */
    tU08 ssoe  :1;      /*slave select output enable */
    tU08 cpha  :1;      /*clock phase */
    tU08 cpol  :1;      /*clock polarity */
    tU08 mstr  :1;      /*master/slave mode select */
    tU08 sptie :1;      /*transmit interrupt enable */
    tU08 spe   :1;      /*spi enable */
    tU08 spie  :1;      /*spi interrupt enable */
    }bit;
  }tSPICR1;

#define LSBFE  0x01  /*bit masks */
#define SSOE   0x02
#define CPHA   0x04
#define CPOL   0x08
#define MSTR   0x10
#define SPTIE  0x20
#define SPE    0x40
#define SPIE   0x80

typedef union uSPICR2
  {
  tU08   byte;
  struct
    {
    tU08 spc0    :1; /*serial pin control 0 */
    tU08 spiswai :1; /*stop in wait mode  */
    tU08         :1; /*not used */
    tU08 bidiroe :1; /*bi-directional mode output enable */
    tU08 modfen  :1; /*mode fault enable  */
    tU08         :3; /*not used */
    }bit;
  }tSPICR2;

#define SPC0   0x01  /*bit masks */
#define SPISWAI   0x02
#define BIDIROE   0x08
#define MODFEN 0x10


typedef union uSPIBR
  {
  tU08   byte;
  struct
    {
    tU08 spr   :3;      /*baud rate selection */
    tU08       :1;      /*not used*/                           
    tU08 sppr  :3;      /*baud rate pre-selection */
    tU08       :1;      /*not used */                             
    }bit;
  }tSPIBR;

#define SPR0   0x01  /*bit masks */
#define SPR1   0x02
#define SPR2   0x04
#define SPR    0x07  /*baud rate selection mask */
#define SPPR0  0x10
#define SPPR1  0x20
#define SPPR2  0x40  
#define SPPR   0x70  /*baud rate pre-selection mask */

typedef union uSPISR
  {
  tU08   byte;
  struct
    {
    tU08       :4;      /*not used */
    tU08 modf  :1;      /*mode error interrupt status flag */
    tU08 sptef :1;      /*transmit empty interrupt flag */
    tU08       :1;      /*not used */
    tU08 spif  :1;      /*spi interrupt request */
    }bit;
  }tSPISR;

#define MODF   0x10  /*bit masks */
#define SPTEF  0x20
#define SPIF   0x80


typedef struct          /*spi datastructure  */
  {
  volatile tSPICR1   spicr1;  /*spi control register 1 */
  volatile tSPICR2   spicr2;  /*spi control register 2 */
  volatile tSPIBR    spibr;   /*spi baud rate register */
  volatile tSPISR    spisr;   /*spi status register */
           tU08      sv;      /*reserved (maintaining memory map) */
  volatile tREG08    spidr;   /*spi data register  */
           tU16      sv2;     /*reserved (maintaining module memory map) */
  }tSPI;

#endif /*S12SPIV4_H */