File content as of revision 15:6f2798e45099:

/*
    Copyright (c) 2016 Fred Kellerman
 
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:
 
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
 
    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
    
    @file          WncController.h
    @purpose       Controls WNC Cellular Modem
    @version       1.0
    @date          July 2016
    @author        Fred Kellerman
*/

#ifndef __WNCCONTROLLERK64F_H_
#define __WNCCONTROLLERK64F_H_

#include <string>
#include <stdint.h>
#include "mbed.h"
#include "MODSERIAL.h"
#include "WncController.h"

namespace WncControllerK64F_fk {

using namespace WncController_fk;
using namespace std;

struct WncGpioPinListK64F {
    /////////////////////////////////////////////////////
    // NXP GPIO Pins that are used to initialize the WNC Shield
    /////////////////////////////////////////////////////
    DigitalOut * mdm_uart2_rx_boot_mode_sel;   // on powerup, 0 = boot mode, 1 = normal boot
    DigitalOut * mdm_power_on;                 // 0 = turn modem on, 1 = turn modem off (should be held high for >5 seconds to cycle modem)
    DigitalOut * mdm_wakeup_in;                // 0 = let modem sleep, 1 = keep modem awake -- Note: pulled high on shield
    DigitalOut * mdm_reset;                    // active high
    DigitalOut * shield_3v3_1v8_sig_trans_ena; // 0 = disabled (all signals high impedence, 1 = translation active
    DigitalOut * mdm_uart1_cts;
};    

class WncControllerK64F : public WncController
{
public:
    /**
     *  \brief Constructor for UART controlled WNC
     *
     *  \param [in] wnc_uart - Reference to a SerialBuffered object which will
     *  be used as the bus to control the WNC.  apnStr = a text string for
     *  the cellular APN name.
     *
     *  \return None.
     *
     *  \details Adding another way to talk to the WNC, like I2C or USB,
     *  a constructor should be added for each type just like the SerialBuffered
     *  constructor below.  Assumes UART is enabled, setup and ready to go. This
     *  class will read and write to this UART.
     */
    WncControllerK64F(struct WncGpioPinListK64F * pPins, MODSERIAL * wnc_uart, MODSERIAL * debug_uart = NULL);
    
    /**
     *  \brief Activates a mode where the user can send text to and from the K64F
     *  debug Serial port directly to the WNC.
     *
     *  \param [in] echoOn - set to true to enable terminal echo
     *
     *  \return true - if terminal mode was successfully entered and exited.
     *
     *  \details Activates a mode where the user can send text to and from the K64F
     *  debug Serial port directly to the WNC.  The mode is entered via this
     *  call.  The mode is exited when the user types CTRL-Q.  While in this
     *  mode all text to and from the WNC is consumed by the debug Serial port.
     *  No other methods in the class will receive any of the WNC output.
     */
    bool enterWncTerminalMode(MODSERIAL *pUart, bool echoOn);
    
private:

    // Disallow copy
//    WncControllerK64F operator=(WncControllerK64F lhs);

    // Users must define these functionalities:
    virtual int putc(char c);
    virtual int puts(const char * s);
    virtual char getc(void);
    virtual int charReady(void);
    virtual int dbgWriteChar(char b);
    virtual int dbgWriteChars(const char *b);
    virtual bool initWncModem(uint8_t powerUpTimeoutSecs);
    virtual void waitMs(int t);
    virtual void waitUs(int t);
    
    virtual int  getLogTimerTicks(void);
    virtual void startTimerA(void);
    virtual void stopTimerA(void);
    virtual int  getTimerTicksA_mS(void);
    virtual void startTimerB(void);
    virtual void stopTimerB(void);
    virtual int  getTimerTicksB_mS(void);

    MODSERIAL * m_pDbgUart;
    MODSERIAL * m_pWncUart;
    WncGpioPinListK64F m_gpioPinList;
    mbed::Timer m_logTimer;
    mbed::Timer m_timerA;
    mbed::Timer m_timerB;
};

};  // End namespace WncController_fk

#endif