gps.h

Go to the documentation of this file.

/* Copyright 2013-2014, Peter A. Bigot
 *
 * All rights reserved.
 *
 * 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 the software 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 HOLDER 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 BSP430_UTILITY_GPS_H
#define BSP430_UTILITY_GPS_H

#include <bsp430/core.h>
#include <time.h>

#define BSP430_GPS_EPOCH_POSIX 315964800UL

#define BSP430_GPS_GPS_UTC_OFFSET_S -16

typedef int (* iBSP430gpsSerialCallback_ni) (const uint8_t * msg,
                                             size_t len,
                                             unsigned long rx_utt);

void vBSP430gpsReleaseMessage_ni (const uint8_t * msg);

typedef int (* iBSP430gpsPPSCallback_ni) (unsigned long pps_tck);

typedef int (* iBSP430gpsTransmitComplete_ni) (const uint8_t * msg,
                                               int rc);

typedef struct sBSP430gpsConfiguration {
  tBSP430periphHandle nmea_serial;

  unsigned long nmea_baud;

  tBSP430periphHandle pps_port;

  unsigned int pps_port_bit;

  tBSP430periphHandle pps_timer;

  int pps_ccidx;

  unsigned int pps_ccis;

  iBSP430gpsSerialCallback_ni serial_cb;

  iBSP430gpsPPSCallback_ni pps_cb;
} sBSP430gpsConfiguration;

int iBSP430gpsInitialize_ni (const sBSP430gpsConfiguration * configp,
                             void * devconfigp);

int iBSP430gpsShutdown_ni ();

int iBSP430gpsExtractTime (const uint8_t * msg,
                           size_t len,
                           struct tm * tmp);

int iBSP430gpsGPStoUTCOffset_s_ni (void);

void vBSP430gpsGPStoUTCOffset_s_ni (int gps_to_utc_offset_s);

time_t xBSP430gpsConvertGPStoUTC_ni (unsigned int weekno,
                                     unsigned long sow);

int iBSP430gpsTransmit_ni (const uint8_t * msg,
                           size_t len,
                           iBSP430gpsTransmitComplete_ni complete_cb);

#endif /* BSP430_UTILITY_GPS_H */