/*
 * libhpfiles, libhpcables, libhpcalcs: hand-helds support libraries.
 * Copyright (C) 2013 Lionel Debroux
 * Code patterns and snippets borrowed from libticables & libticalcs:
 * Copyright (C) 1999-2009 Romain Liévin
 * Copyright (C) 2009-2013 Lionel Debroux
 * Copyright (C) 1999-2013 libti* contributors.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
 * \file hplibs.h Files, Cables, Calcs: definitions common to libhpfiles, libhpcables, libhpcalcs.
 */

#ifndef __HPLIBS_H__
#define __HPLIBS_H__

#include <stddef.h>

#include "export.h"

//! Enumeration of cable types.
typedef enum {
    CABLE_NUL = 0,
    CABLE_PRIME_HID,
    CABLE_MAX
} cable_model;

//! Enumeration of calculator types.
typedef enum {
    CALC_NONE = 0,
    CALC_PRIME,
    CALC_MAX
} calc_model;

//! Enumeration of logging levels.
typedef enum {
    LOG_LEVEL_ALL = 0,
    LOG_LEVEL_DEBUG,
    LOG_LEVEL_INFO,
    LOG_LEVEL_WARN,
    LOG_LEVEL_ERROR
} hplibs_logging_level;

//! Struct containing function pointers used by the libraries for dynamic memory allocation.
typedef struct {
   void * (*malloc)(size_t size); ///< A malloc()-compatible function
   void * (*calloc) (size_t nmemb, size_t size); ///< A calloc()-compatible function
   void * (*realloc)(void *ptr, size_t size); ///< A realloc()-compatible function
   void (*free) (void *ptr); ///< A free()-compatible function
} hplibs_malloc_funcs;

//! USB Vendor ID of Hewlett-Packard.
#define USB_VID_HP (0x03F0)
//! USB Product ID of the Prime calculator in firmware revisions < 8151.
#define USB_PID_PRIME1 (0x0441)
//! USB Product ID of the Prime calculator in firmware revisions >= 8151.
#define USB_PID_PRIME2 (0x1541)
//! USB Product ID of the Prime calculator in firmware revisions >= 8151.
#define USB_PID_PRIME3 (0x2441)


//! Size of a raw HID packet for the Prime.
#define PRIME_RAW_HID_DATA_SIZE (64)

#ifdef __cplusplus
extern "C" {
#endif

/**
 * \brief Gets the error message if the error was produced by a libhp* library
 * \param number the error number (from above)
 * \param message out pointer for a newly allocated text error message, which must be freed by the caller
 *
 * \return the error number.
 **/
HPEXPORT int HPCALL hplibs_error_get(int number, char **message);

#ifdef __cplusplus
}
#endif

#endif