File content as of revision 0:e89ba455dbcf:

/*
 * spi.h - mbed
 *
 * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com/
 *
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS 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 SPI_H_
#define SPI_H_

#include "mbed.h"


/*!
    \brief   type definition for the spi channel file descriptor

    \note    On each porting or platform the type could be whatever is needed
            - integer, pointer to structure etc.
*/
typedef unsigned int Fd_t;

typedef void (*P_EVENT_HANDLER)(void* pValue); 

namespace mbed_cc3100 {
    
class cc3100_driver;    
    
class cc3100_spi
{
public:

    cc3100_spi(PinName cc3100_irq, PinName cc3100_nHIB, PinName cc3100_cs, SPI cc3100_spi, cc3100_driver &driver);

    ~cc3100_spi();


    /*!
        \brief          Enables the CC3100

        \param[in]      none

        \return         none

        \note

        \warning
    */
    void CC3100_enable();

    /*!
        \brief          Disables the CC3100

        \param[in]      none

        \return         none

        \note

        \warning
    */
    void CC3100_disable();

    /*!
        \brief          Enables the interrupt from the CC3100

        \param[in]      none

        \return         none

        \note

        \warning
    */
    void cc3100_InterruptEnable();

    /*!
        \brief          Disables the interrupt from the CC3100

        \param[in]      none

        \return         none

        \note

        \warning
    */
    void cc3100_InterruptDisable();

    /*!
        \brief open spi communication port to be used for communicating with a
               SimpleLink device

        Given an interface name and option flags, this function opens the spi
        communication port and creates a file descriptor. This file descriptor can
        be used afterwards to read and write data from and to this specific spi
        channel.
        The SPI speed, clock polarity, clock phase, chip select and all other
        attributes are all set to hardcoded values in this function.

        \param[in]      ifName    -    points to the interface name/path. The
                        interface name is an optional attributes that the simple
                        link driver receives on opening the device. in systems that
                        the spi channel is not implemented as part of the os device
                        drivers, this parameter could be NULL.
        \param[in]      flags     -    option flags

        \return         upon successful completion, the function shall open the spi
                        channel and return a non-negative integer representing the
                        file descriptor. Otherwise, -1 shall be returned

        \sa             spi_Close , spi_Read , spi_Write
        \note
        \warning
    */

    Fd_t spi_Open(int8_t *ifName, uint32_t flags);

    /*!
        \brief closes an opened spi communication port

        \param[in]      fd    -     file descriptor of an opened SPI channel

        \return         upon successful completion, the function shall return 0.
                        Otherwise, -1 shall be returned

        \sa             spi_Open
        \note
        \warning
    */
    int spi_Close(Fd_t fd);

    /*!
        \brief attempts to read up to len bytes from SPI channel into a buffer
               starting at pBuff.

        \param[in]      fd     -    file descriptor of an opened SPI channel

        \param[in]      pBuff  -    points to first location to start writing the
                        data

        \param[in]      len    -    number of bytes to read from the SPI channel

        \return         upon successful completion, the function shall return 0.
                        Otherwise, -1 shall be returned

        \sa             spi_Open , spi_Write
        \note
        \warning
    */
    int spi_Read(Fd_t fd, uint8_t *pBuff, int len);

    /*!
        \brief attempts to write up to len bytes to the SPI channel

        \param[in]      fd        -    file descriptor of an opened SPI channel

        \param[in]      pBuff     -    points to first location to start getting the
                        data from

        \param[in]      len       -    number of bytes to write to the SPI channel

        \return         upon successful completion, the function shall return 0.
                        Otherwise, -1 shall be returned

        \sa             spi_Open , spi_Read
        \note           This function could be implemented as zero copy and return
                        only upon successful completion of writing the whole buffer,
                        but in cases that memory allocation is not too tight, the
                        function could copy the data to internal buffer, return
                        back and complete the write in parallel to other activities
                        as long as the other SPI activities would be blocked untill
                        the entire buffer write would be completed
        \warning
    */
    int spi_Write(Fd_t fd, uint8_t *pBuff, int len);

    /*!
        \brief          The IntSpiGPIOHandler interrupt handler

        \param[in]      none

        \return         none

        \note

        \warning
    */
    void IntSpiGPIOHandler(void);

    /*!
        \brief register an interrupt handler for the host IRQ

        \param[in]      InterruptHdl    -    pointer to interrupt handler function

        \param[in]      pValue          -    pointer to a memory strcuture that is
                        passed to the interrupt handler.

        \return         upon successful registration, the function shall return 0.
                        Otherwise, -1 shall be returned

        \sa
        \note           If there is already registered interrupt handler, the
                        function should overwrite the old handler with the new one
        \warning
    */
    int registerInterruptHandler(P_EVENT_HANDLER InterruptHdl , void* pValue);

    /*!
        \brief      Masks the Host IRQ

        \param[in]      none

        \return         none

        \warning
    */
    void MaskIntHdlr();

    /*!
        \brief     Unmasks the Host IRQ

        \param[in]      none

        \return         none

        \warning
    */
    void UnMaskIntHdlr();

    
private:

    InterruptIn         _wlan_irq;
    DigitalOut          _wlan_nHIB;
    DigitalOut          _wlan_cs;
    SPI                 _wlan_spi;
    cc3100_driver       &_driver;


};//class
}//namespace mbed_cc3100
#endif