48285dcfdf
Ports being forced to get closed will only happen when we get a HUP error in the serial port (e.g. device got disconnected).
147 lines
6.3 KiB
C
147 lines
6.3 KiB
C
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* 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:
|
|
*
|
|
* Copyright (C) 2008 - 2009 Novell, Inc.
|
|
* Copyright (C) 2009 - 2010 Red Hat, Inc.
|
|
*/
|
|
|
|
#ifndef MM_SERIAL_PORT_H
|
|
#define MM_SERIAL_PORT_H
|
|
|
|
#include <glib.h>
|
|
#include <glib-object.h>
|
|
#include <gio/gio.h>
|
|
|
|
#include "mm-port.h"
|
|
|
|
#define MM_TYPE_SERIAL_PORT (mm_serial_port_get_type ())
|
|
#define MM_SERIAL_PORT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_SERIAL_PORT, MMSerialPort))
|
|
#define MM_SERIAL_PORT_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_SERIAL_PORT, MMSerialPortClass))
|
|
#define MM_IS_SERIAL_PORT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_SERIAL_PORT))
|
|
#define MM_IS_SERIAL_PORT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_SERIAL_PORT))
|
|
#define MM_SERIAL_PORT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_SERIAL_PORT, MMSerialPortClass))
|
|
|
|
#define MM_SERIAL_PORT_BAUD "baud"
|
|
#define MM_SERIAL_PORT_BITS "bits"
|
|
#define MM_SERIAL_PORT_PARITY "parity"
|
|
#define MM_SERIAL_PORT_STOPBITS "stopbits"
|
|
#define MM_SERIAL_PORT_SEND_DELAY "send-delay"
|
|
#define MM_SERIAL_PORT_RTS_CTS "rts-cts"
|
|
#define MM_SERIAL_PORT_FD "fd" /* Construct-only */
|
|
#define MM_SERIAL_PORT_SPEW_CONTROL "spew-control" /* Construct-only */
|
|
#define MM_SERIAL_PORT_FLASH_OK "flash-ok" /* Construct-only */
|
|
|
|
typedef struct _MMSerialPort MMSerialPort;
|
|
typedef struct _MMSerialPortClass MMSerialPortClass;
|
|
|
|
typedef void (*MMSerialFlashFn) (MMSerialPort *port,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
typedef void (*MMSerialResponseFn) (MMSerialPort *port,
|
|
GByteArray *response,
|
|
GError *error,
|
|
gpointer user_data);
|
|
|
|
|
|
struct _MMSerialPort {
|
|
MMPort parent;
|
|
};
|
|
|
|
struct _MMSerialPortClass {
|
|
MMPortClass parent;
|
|
|
|
/* Called for subclasses to parse unsolicited responses. If any recognized
|
|
* unsolicited response is found, it should be removed from the 'response'
|
|
* byte array before returning.
|
|
*/
|
|
void (*parse_unsolicited) (MMSerialPort *self, GByteArray *response);
|
|
|
|
/* Called to parse the device's response to a command or determine if the
|
|
* response was an error response. If the response indicates an error, an
|
|
* appropriate error should be returned in the 'error' argument. The
|
|
* function should return FALSE if there is not enough data yet to determine
|
|
* the device's reply (whether success *or* error), and should return TRUE
|
|
* when the device's response has been recognized and parsed.
|
|
*/
|
|
gboolean (*parse_response) (MMSerialPort *self,
|
|
GByteArray *response,
|
|
GError **error);
|
|
|
|
/* Called after parsing to allow the command response to be delivered to
|
|
* it's callback to be handled. Returns the # of bytes of the response
|
|
* consumed.
|
|
*/
|
|
gsize (*handle_response) (MMSerialPort *self,
|
|
GByteArray *response,
|
|
GError *error,
|
|
GCallback callback,
|
|
gpointer callback_data);
|
|
|
|
/* Called to configure the serial port after it's opened. On error, should
|
|
* return FALSE and set 'error' as appropriate.
|
|
*/
|
|
gboolean (*config_fd) (MMSerialPort *self, int fd, GError **error);
|
|
|
|
void (*debug_log) (MMSerialPort *self,
|
|
const char *prefix,
|
|
const char *buf,
|
|
gsize len);
|
|
|
|
/* Signals */
|
|
void (*buffer_full) (MMSerialPort *port, const GByteArray *buffer);
|
|
void (*timed_out) (MMSerialPort *port, guint n_consecutive_replies);
|
|
};
|
|
|
|
GType mm_serial_port_get_type (void);
|
|
|
|
MMSerialPort *mm_serial_port_new (const char *name, MMPortType ptype);
|
|
|
|
/* Keep in mind that port open/close is refcounted, so ensure that
|
|
* open/close calls are properly balanced.
|
|
*/
|
|
|
|
gboolean mm_serial_port_is_open (MMSerialPort *self);
|
|
|
|
gboolean mm_serial_port_open (MMSerialPort *self,
|
|
GError **error);
|
|
|
|
void mm_serial_port_close (MMSerialPort *self);
|
|
|
|
gboolean mm_serial_port_flash (MMSerialPort *self,
|
|
guint32 flash_time,
|
|
gboolean ignore_errors,
|
|
MMSerialFlashFn callback,
|
|
gpointer user_data);
|
|
|
|
void mm_serial_port_flash_cancel (MMSerialPort *self);
|
|
|
|
gboolean mm_serial_port_get_flash_ok (MMSerialPort *self);
|
|
|
|
void mm_serial_port_queue_command (MMSerialPort *self,
|
|
GByteArray *command,
|
|
gboolean take_command,
|
|
guint32 timeout_seconds,
|
|
GCancellable *cancellable,
|
|
MMSerialResponseFn callback,
|
|
gpointer user_data);
|
|
|
|
void mm_serial_port_queue_command_cached (MMSerialPort *self,
|
|
GByteArray *command,
|
|
gboolean take_command,
|
|
guint32 timeout_seconds,
|
|
GCancellable *cancellable,
|
|
MMSerialResponseFn callback,
|
|
gpointer user_data);
|
|
|
|
#endif /* MM_SERIAL_PORT_H */
|