2021年07月30日 | MC9S12XEP100 SPI模块 驱动程序

之前发了MC9S12XEP100数据手册上的SPI模块的翻译http://blog.csdn.net/lin_strong/article/details/79122482。

于是乎，现在对其的封装也来了。目前先完成了硬件驱动部分的封装。软件部分还没完全想好怎么弄。

这次的封装我尝试使用两个头文件的方式来区分protect与public。

全部内部使用的函数(不带参数检查)都放在了SPI_Internal.h中，而对用户的接口(可选参数检查)都放在了SPI.h中

使用时请只#include “SPI.h” 然后使用里头提供的接口。

下面上代码：

/*

*******************************************************************************************

*

*

*                       SPI(Serial Peripheral Interface) SUPPORT PACKAGE

*                                         SPI支持包

*

* File : SPI.h

* By   : Lin Shijun(http://blog.csdn.net/lin_strong)

* Date:  2019/03/05

* version: V1.1

* History: 2018/02/01  V1.0   the prototype

*          2019/03/05  V1.1   some modification to the malloc configuration.

*                             uncomment struct style initializer and change name to SPI_InitExt

*                               to include both initializers.

* NOTE(s):a.refer to the code of uCOS-II

*         b.this file define the interface for user. user should include this file to use the 

*           spi module.

*         c.this module has three files — SPI.h、SPI_Internal.h、SPI.c

*         d.steps to use this module:

*              1. define malloc to configure the parameters in CONFIGURE and INITIALIZATION

*                 CONFIGURE, or use the default.

*              2. use the interface function to send/receive data. e.g.

*                   ......

*                   INT8U dataSend,dataRecv;

*                   SPI_Init(SPI0);

*                   SPI_Enable(SPI0);

*                   while(TRUE){

*                      dataRecv = SPI_ExchangeChar(SPI0,dataSend);

*                      // deal with the dataRecv.

*                   }

*********************************************************************************************

*/

#ifndef   SPI_H

#define   SPI_H

/*

*******************************************************************************************

*                                    INCLUDES

*******************************************************************************************

*/

#include

#include "common.h"

/*

******************************************************************************************

*                                    CONSTANT

******************************************************************************************

*/

#define   SPI0      0x00                         /*   SPI0           */

#define   SPI1      0x01                         /*   SPI1           */

#define   SPI2      0x02                         /*   SPI2           */

// spi behavior when cpu is in wait mode

#define SPI_INWAITMODE_STOP    0      // SPI module will keep running when cpu in wait mode

#define SPI_INWAITMODE_RUN     1      // SPI module will stop when cpu in wait mode

// format of spi clock

#define SPI_SCKFMT_MODE_0      0      // CPHA=0、CPOL=0

#define SPI_SCKFMT_MODE_1      1      // CPHA=0、CPOL=1

#define SPI_SCKFMT_MODE_2      2      // CPHA=1、CPOL=0

#define SPI_SCKFMT_MODE_3      3      // CPHA=1、CPOL=1

// the bit order when transmit/receive.

#define SPI_BITORDER_LSB       0      // Least significant bit first

#define SPI_BITORDER_MSB       1      // Most significant bit first

// how spi system control SS pin

#define SPI_SS_CTRL_OFF        0      // SPI module don't use SS pin.

#define SPI_SS_CTRL_ON         1      // only for master, SS pin is used for slave control.

#define SPI_SS_LISTEN_MODF     2      // only for master, SS pin is used for listening mode fault 

/*

*******************************************************************************************

*                               CONFIGURATION 主配置

*******************************************************************************************

*/

// TRUE: just use single port(declare in SPI_MONOPORT_USED), so the module can create

//       optimised code.

// #define SPI_MONOPORT_NEEDED to specify that you will just use one SPI port

#ifdef  SPI_MONOPORT_NEEDED

// if just use one SPI port, #define SPI_MONOPORT_USED to specify which port you use.

// default SPI0

  #ifndef SPI_MONOPORT_USED

    #define SPI_MONOPORT_USED    SPI0

  #endif

#endif

// #define SPI_ARGUMENT_CHECK_DISABLE to specify that you don't need the argument check

//   function of spi module.

// #define SPI_ARGUMENT_CHECK_DISABLE

/*

****************************************************************************************

*                                  ERROR CODES

****************************************************************************************

*/

#define  SPI_NO_ERR            0        /* Function call was successful                       */  

#define  SPI_INVALID_PORT      1        /* Invalid communications port channel                */  

#define  SPI_ARGUMENT_OUT      2        /* Argument out of range                              */  

#define  SPI_RX_EMPTY          3        /* Rx buffer is empty, no character available         */  

#define  SPI_TX_FULL           4        /* Tx buffer is full, could not deposit character     */  

#define  SPI_TX_EMPTY          5        /* If the Tx buffer is empty.                         */  

#define  SPI_RX_TIMEOUT        6        /* If a timeout occurred while waiting for a character*/  

#define  SPI_TX_TIMEOUT        7        /* If a timeout occurred while waiting to send a char.*/

#define  SPI_ERR_UNKNOWN       8

/*

******************************************************************************************

*                                  TYPE DEFINE

******************************************************************************************

*/

// for struct init-style

typedef struct spi_init_struct{

  unsigned char isMaster;   // TRUE: spi is master. FALSE: spi is slave.

  unsigned char SSctrl;     // see SPI_SS_CTRL

  unsigned char bitorder;   // see SPI_BITORDER

  unsigned char inWaitMode; // see SPI_INWAITMODE

  unsigned char sckfmt;     // see SPI_SCKFMT

// BaudRateDivisor = (SPPR + 1) * 2^(SPR + 1)

// BaudRate = Busclock / BaudRateDivisor

  unsigned char SPR;        // 0-7,SPI Baud Rate Selection

  unsigned char SPPR;       // 0-7,SPI Baud Rate Preselection

}SPI_INIT_STRUCT,*pSPI_INIT_STRUCT;

/*

*******************************************************************************************

*                        INITIALIZATION CONFIGURATION 初始化配置

*******************************************************************************************

*/

// the default parameter to initialize the SPI system

// 初始化SPI的默认参数

#ifndef SPI_INIT_ISMASTER

  #define SPI_INIT_ISMASTER         TRUE                 // TRUE: spi is master. FALSE: spi is slave.

#endif

#ifndef SPI_INIT_SSCTRL

  #define SPI_INIT_SSCTRL           SPI_SS_CTRL_OFF      // see SPI_SS_CTRL

#endif

#ifndef SPI_INIT_BITORDER

  #define SPI_INIT_BITORDER         SPI_BITORDER_MSB     // see SPI_BITORDER