util.h

/*
 * Auxiliary functions.
 *
 * Copyright (C) 2013 Serge Vakulenko, KK6ABQ
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. 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.
 *   3. The name of the author may not be used to endorse or promote products
 *      derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
 */
#include <stdio.h>
#include <stdbool.h>

//
// Localization.
//
#if 0
    /* Use gettext(). */
#include <libintl.h>
#define _(str) gettext(str)
#else
/* No localization. */
#define _(str)                      str
#define textdomain(name)            /* empty */
#define bindtextdomain(name, dir)   /* empty */
#define setlocale(category, locale) /* empty */
#endif

//
// Trace data i/o via the serial port.
//
extern bool trace_flag;

//
// CTCSS tones, Hz*10.
//
#define NCTCSS 50

extern const int CTCSS_TONES[NCTCSS];

//
// DCS codes.
//
#define NDCS 104

extern const int DCS_CODES[NDCS];

//
// Print data in hex format.
//
void print_hex(const unsigned char *data, int len);

//
// Open the serial port.
//
int serial_open(const char *portname);

//
// Close the serial port.
//
void serial_close(int fd);

//
// Purge all received data.
//
void serial_flush(int fd);

//
// Read data from serial port.
// Return 0 when no data available.
// Use 200-msec timeout.
//
int serial_read(int fd, unsigned char *data, int len);

//
// Write data to serial port.
//
void serial_write(int fd, const void *data, int len);

//
// Delay in milliseconds.
//
void mdelay(unsigned msec);

//
// Check for a regular file.
//
int is_file(const char *filename);

//
// Check whether a binary coded decimal is invalid.
//
int bcd_invalid(unsigned bcd);

//
// Convert 32-bit value from binary coded decimal
// to integer format (8 digits).
//
int bcd_to_int(int bcd);

//
// Convert 32-bit value from integer
// binary coded decimal format (8 digits).
//
int int_to_bcd(int val);

//
// Convert array of 8-bit values from binary coded decimal
// to integer format (8 digits).
//
int bcd4_to_int(unsigned char bcd[4]);

//
// Convert binary coded decimal format (8 digits)
// from integer to array of 8-bit values.
//
void int_to_bcd4(int val, unsigned char bcd[4]);

//
// Get a binary value of the parameter: On/Off,
// Ignore case.
//
int on_off(const char *param, const char *value);

//
// Get integer value, or "Off" as 0,
// Ignore case.
//
int atoi_off(const char *value);

//
// Copy a text string to memory image.
// Clear unused space to zero.
//
void copy_str(unsigned char *dest, const char *src, int nbytes);

//
// Find a string in a table of size nelem, ignoring case.
// Return -1 when not found.
//
int string_in_table(const char *value, const char *tab[], int nelem);

//
// Print description of the parameter.
//
void print_options(FILE *out, const char **tab, int num, const char *info);

//
// Print list of all squelch tones.
//
void print_squelch_tones(FILE *out, int normal_only);

//
// Copy string, trim spaces.
//
const char *trim_str(const char *src, unsigned nbytes, char *buf);

//
// Round double value to integer.
//
int iround(double x);