2014-07-24 12:53:33 +00:00
|
|
|
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This library is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
|
|
* License as published by the Free Software Foundation; either
|
|
|
|
* version 2 of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This library 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
|
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
|
|
* License along with this library; if not, write to the
|
|
|
|
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
* Boston, MA 02110-1301 USA.
|
|
|
|
*
|
|
|
|
* Copyright 2007 - 2011 Red Hat, Inc.
|
|
|
|
* Copyright 2007 - 2008 Novell, Inc.
|
|
|
|
*/
|
|
|
|
|
2016-02-19 13:57:48 +00:00
|
|
|
#include "nm-default.h"
|
2014-11-13 15:07:02 +00:00
|
|
|
|
2014-07-24 12:53:33 +00:00
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
#include "nm-setting-serial.h"
|
|
|
|
#include "nm-setting-private.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* SECTION:nm-setting-serial
|
|
|
|
* @short_description: Describes connection properties for devices that use
|
|
|
|
* serial communications
|
|
|
|
*
|
|
|
|
* The #NMSettingSerial object is a #NMSetting subclass that describes
|
|
|
|
* properties necessary for connections that may use serial communications,
|
|
|
|
* such as mobile broadband or analog telephone connections.
|
|
|
|
**/
|
|
|
|
|
|
|
|
G_DEFINE_TYPE_WITH_CODE (NMSettingSerial, nm_setting_serial, NM_TYPE_SETTING,
|
2014-08-07 21:19:40 +00:00
|
|
|
_nm_register_setting (SERIAL, 2))
|
2014-07-24 12:53:33 +00:00
|
|
|
NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_SERIAL)
|
|
|
|
|
|
|
|
#define NM_SETTING_SERIAL_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_SERIAL, NMSettingSerialPrivate))
|
|
|
|
|
|
|
|
typedef struct {
|
|
|
|
guint baud;
|
|
|
|
guint bits;
|
|
|
|
char parity;
|
|
|
|
guint stopbits;
|
|
|
|
guint64 send_delay;
|
|
|
|
} NMSettingSerialPrivate;
|
|
|
|
|
|
|
|
|
|
|
|
enum {
|
|
|
|
PROP_0,
|
|
|
|
PROP_BAUD,
|
|
|
|
PROP_BITS,
|
|
|
|
PROP_PARITY,
|
|
|
|
PROP_STOPBITS,
|
|
|
|
PROP_SEND_DELAY,
|
|
|
|
|
|
|
|
LAST_PROP
|
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nm_setting_serial_new:
|
|
|
|
*
|
|
|
|
* Creates a new #NMSettingSerial object with default values.
|
|
|
|
*
|
|
|
|
* Returns: (transfer full): the new empty #NMSettingSerial object
|
|
|
|
**/
|
|
|
|
NMSetting *
|
|
|
|
nm_setting_serial_new (void)
|
|
|
|
{
|
|
|
|
return (NMSetting *) g_object_new (NM_TYPE_SETTING_SERIAL, NULL);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nm_setting_serial_get_baud:
|
|
|
|
* @setting: the #NMSettingSerial
|
|
|
|
*
|
|
|
|
* Returns: the #NMSettingSerial:baud property of the setting
|
|
|
|
**/
|
|
|
|
guint
|
|
|
|
nm_setting_serial_get_baud (NMSettingSerial *setting)
|
|
|
|
{
|
|
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->baud;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nm_setting_serial_get_bits:
|
|
|
|
* @setting: the #NMSettingSerial
|
|
|
|
*
|
|
|
|
* Returns: the #NMSettingSerial:bits property of the setting
|
|
|
|
**/
|
|
|
|
guint
|
|
|
|
nm_setting_serial_get_bits (NMSettingSerial *setting)
|
|
|
|
{
|
|
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->bits;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nm_setting_serial_get_parity:
|
|
|
|
* @setting: the #NMSettingSerial
|
|
|
|
*
|
|
|
|
* Returns: the #NMSettingSerial:parity property of the setting
|
|
|
|
**/
|
2014-09-24 13:12:46 +00:00
|
|
|
NMSettingSerialParity
|
2014-07-24 12:53:33 +00:00
|
|
|
nm_setting_serial_get_parity (NMSettingSerial *setting)
|
|
|
|
{
|
|
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->parity;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nm_setting_serial_get_stopbits:
|
|
|
|
* @setting: the #NMSettingSerial
|
|
|
|
*
|
|
|
|
* Returns: the #NMSettingSerial:stopbits property of the setting
|
|
|
|
**/
|
|
|
|
guint
|
|
|
|
nm_setting_serial_get_stopbits (NMSettingSerial *setting)
|
|
|
|
{
|
|
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->stopbits;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* nm_setting_serial_get_send_delay:
|
|
|
|
* @setting: the #NMSettingSerial
|
|
|
|
*
|
|
|
|
* Returns: the #NMSettingSerial:send-delay property of the setting
|
|
|
|
**/
|
|
|
|
guint64
|
|
|
|
nm_setting_serial_get_send_delay (NMSettingSerial *setting)
|
|
|
|
{
|
|
|
|
g_return_val_if_fail (NM_IS_SETTING_SERIAL (setting), 0);
|
|
|
|
|
|
|
|
return NM_SETTING_SERIAL_GET_PRIVATE (setting)->send_delay;
|
|
|
|
}
|
|
|
|
|
|
|
|
static gboolean
|
2014-10-22 02:30:31 +00:00
|
|
|
verify (NMSetting *setting, NMConnection *connection, GError **error)
|
2014-07-24 12:53:33 +00:00
|
|
|
{
|
|
|
|
return TRUE;
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
nm_setting_serial_init (NMSettingSerial *setting)
|
|
|
|
{
|
|
|
|
}
|
|
|
|
|
2014-09-24 13:12:46 +00:00
|
|
|
static GVariant *
|
|
|
|
parity_to_dbus (const GValue *from)
|
|
|
|
{
|
|
|
|
switch (g_value_get_enum (from)) {
|
|
|
|
case NM_SETTING_SERIAL_PARITY_EVEN:
|
|
|
|
return g_variant_new_byte ('E');
|
|
|
|
case NM_SETTING_SERIAL_PARITY_ODD:
|
|
|
|
return g_variant_new_byte ('o');
|
|
|
|
case NM_SETTING_SERIAL_PARITY_NONE:
|
|
|
|
default:
|
|
|
|
return g_variant_new_byte ('n');
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
parity_from_dbus (GVariant *from, GValue *to)
|
|
|
|
{
|
|
|
|
switch (g_variant_get_byte (from)) {
|
|
|
|
case 'E':
|
|
|
|
g_value_set_enum (to, NM_SETTING_SERIAL_PARITY_EVEN);
|
|
|
|
break;
|
|
|
|
case 'o':
|
|
|
|
g_value_set_enum (to, NM_SETTING_SERIAL_PARITY_ODD);
|
|
|
|
break;
|
|
|
|
case 'n':
|
|
|
|
default:
|
|
|
|
g_value_set_enum (to, NM_SETTING_SERIAL_PARITY_NONE);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-07-24 12:53:33 +00:00
|
|
|
static void
|
|
|
|
set_property (GObject *object, guint prop_id,
|
|
|
|
const GValue *value, GParamSpec *pspec)
|
|
|
|
{
|
|
|
|
NMSettingSerialPrivate *priv = NM_SETTING_SERIAL_GET_PRIVATE (object);
|
|
|
|
|
|
|
|
switch (prop_id) {
|
|
|
|
case PROP_BAUD:
|
|
|
|
priv->baud = g_value_get_uint (value);
|
|
|
|
break;
|
|
|
|
case PROP_BITS:
|
|
|
|
priv->bits = g_value_get_uint (value);
|
|
|
|
break;
|
|
|
|
case PROP_PARITY:
|
2014-09-24 13:12:46 +00:00
|
|
|
priv->parity = g_value_get_enum (value);
|
2014-07-24 12:53:33 +00:00
|
|
|
break;
|
|
|
|
case PROP_STOPBITS:
|
|
|
|
priv->stopbits = g_value_get_uint (value);
|
|
|
|
break;
|
|
|
|
case PROP_SEND_DELAY:
|
|
|
|
priv->send_delay = g_value_get_uint64 (value);
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
get_property (GObject *object, guint prop_id,
|
|
|
|
GValue *value, GParamSpec *pspec)
|
|
|
|
{
|
|
|
|
NMSettingSerial *setting = NM_SETTING_SERIAL (object);
|
|
|
|
|
|
|
|
switch (prop_id) {
|
|
|
|
case PROP_BAUD:
|
|
|
|
g_value_set_uint (value, nm_setting_serial_get_baud (setting));
|
|
|
|
break;
|
|
|
|
case PROP_BITS:
|
|
|
|
g_value_set_uint (value, nm_setting_serial_get_bits (setting));
|
|
|
|
break;
|
|
|
|
case PROP_PARITY:
|
2014-09-24 13:12:46 +00:00
|
|
|
g_value_set_enum (value, nm_setting_serial_get_parity (setting));
|
2014-07-24 12:53:33 +00:00
|
|
|
break;
|
|
|
|
case PROP_STOPBITS:
|
|
|
|
g_value_set_uint (value, nm_setting_serial_get_stopbits (setting));
|
|
|
|
break;
|
|
|
|
case PROP_SEND_DELAY:
|
|
|
|
g_value_set_uint64 (value, nm_setting_serial_get_send_delay (setting));
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static void
|
|
|
|
nm_setting_serial_class_init (NMSettingSerialClass *setting_class)
|
|
|
|
{
|
|
|
|
GObjectClass *object_class = G_OBJECT_CLASS (setting_class);
|
|
|
|
NMSettingClass *parent_class = NM_SETTING_CLASS (setting_class);
|
|
|
|
|
|
|
|
g_type_class_add_private (setting_class, sizeof (NMSettingSerialPrivate));
|
|
|
|
|
|
|
|
/* virtual methods */
|
|
|
|
object_class->set_property = set_property;
|
|
|
|
object_class->get_property = get_property;
|
|
|
|
parent_class->verify = verify;
|
|
|
|
|
|
|
|
/* Properties */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NMSettingSerial:baud:
|
|
|
|
*
|
|
|
|
* Speed to use for communication over the serial port. Note that this
|
|
|
|
* value usually has no effect for mobile broadband modems as they generally
|
|
|
|
* ignore speed settings and use the highest available speed.
|
|
|
|
**/
|
|
|
|
g_object_class_install_property
|
|
|
|
(object_class, PROP_BAUD,
|
|
|
|
g_param_spec_uint (NM_SETTING_SERIAL_BAUD, "", "",
|
|
|
|
0, G_MAXUINT, 57600,
|
|
|
|
G_PARAM_READWRITE |
|
|
|
|
G_PARAM_CONSTRUCT |
|
|
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NMSettingSerial:bits:
|
|
|
|
*
|
|
|
|
* Byte-width of the serial communication. The 8 in "8n1" for example.
|
|
|
|
**/
|
|
|
|
g_object_class_install_property
|
|
|
|
(object_class, PROP_BITS,
|
|
|
|
g_param_spec_uint (NM_SETTING_SERIAL_BITS, "", "",
|
|
|
|
5, 8, 8,
|
|
|
|
G_PARAM_READWRITE |
|
|
|
|
G_PARAM_CONSTRUCT |
|
|
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NMSettingSerial:parity:
|
|
|
|
*
|
2014-09-24 13:12:46 +00:00
|
|
|
* Parity setting of the serial port.
|
2014-07-24 12:53:33 +00:00
|
|
|
**/
|
libnm, libnm-util: move settings doc generation to libnm-core
Move the settings/plugins doc generation from libnm-util to
libnm-core, since libnm-util isn't being updated for all new
properties.
With this commit, the keyfile and ifcfg-rh documentation is basically
unchanged, except that deprecated properties are now gone, and new
properties have been added, and the sections are in a different order.
(generate-plugin-docs.pl just outputs the settings in Makefile order,
and they were unsorted in libnm-util, but are sorted in libnm-core).
The settings documentation used for nm-settings.5, the D-Bus API docs,
and the nmcli help is changed a bit more at this point, and mostly for
the worse, since the libnm-core setting properties don't match up with
the D-Bus API as well as the libnm-util ones do. To be fixed...
(I also removed the "plugins docs" line in each plugin docs comment
block while moving them, since those blocks will be used for more than
just plugins soon, and it's sort of obvious anyway.)
2014-10-28 13:58:25 +00:00
|
|
|
/* ---keyfile---
|
|
|
|
* property: parity
|
|
|
|
* format: 'e', 'o', or 'n'
|
|
|
|
* description: The connection parity; even, odd, or none. Note that older
|
|
|
|
* versions of NetworkManager stored this as an integer: 69 ('E') for even,
|
|
|
|
* 111 ('o') for odd, or 110 ('n') for none.
|
|
|
|
* example: parity=n
|
|
|
|
* ---end---
|
2014-11-16 20:36:18 +00:00
|
|
|
* ---dbus---
|
|
|
|
* property: parity
|
|
|
|
* format: byte
|
|
|
|
* description: The connection parity: 69 (ASCII 'E') for even parity,
|
|
|
|
* 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.
|
|
|
|
* ---end---
|
libnm, libnm-util: move settings doc generation to libnm-core
Move the settings/plugins doc generation from libnm-util to
libnm-core, since libnm-util isn't being updated for all new
properties.
With this commit, the keyfile and ifcfg-rh documentation is basically
unchanged, except that deprecated properties are now gone, and new
properties have been added, and the sections are in a different order.
(generate-plugin-docs.pl just outputs the settings in Makefile order,
and they were unsorted in libnm-util, but are sorted in libnm-core).
The settings documentation used for nm-settings.5, the D-Bus API docs,
and the nmcli help is changed a bit more at this point, and mostly for
the worse, since the libnm-core setting properties don't match up with
the D-Bus API as well as the libnm-util ones do. To be fixed...
(I also removed the "plugins docs" line in each plugin docs comment
block while moving them, since those blocks will be used for more than
just plugins soon, and it's sort of obvious anyway.)
2014-10-28 13:58:25 +00:00
|
|
|
*/
|
2014-07-24 12:53:33 +00:00
|
|
|
g_object_class_install_property
|
|
|
|
(object_class, PROP_PARITY,
|
2014-09-24 13:12:46 +00:00
|
|
|
g_param_spec_enum (NM_SETTING_SERIAL_PARITY, "", "",
|
|
|
|
NM_TYPE_SETTING_SERIAL_PARITY,
|
|
|
|
NM_SETTING_SERIAL_PARITY_NONE,
|
2014-07-24 12:53:33 +00:00
|
|
|
G_PARAM_READWRITE |
|
|
|
|
G_PARAM_CONSTRUCT |
|
|
|
|
G_PARAM_STATIC_STRINGS));
|
2014-09-24 13:12:46 +00:00
|
|
|
_nm_setting_class_transform_property (parent_class,
|
|
|
|
NM_SETTING_SERIAL_PARITY,
|
|
|
|
G_VARIANT_TYPE_BYTE,
|
|
|
|
parity_to_dbus,
|
|
|
|
parity_from_dbus);
|
2014-07-24 12:53:33 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* NMSettingSerial:stopbits:
|
|
|
|
*
|
|
|
|
* Number of stop bits for communication on the serial port. Either 1 or 2.
|
|
|
|
* The 1 in "8n1" for example.
|
|
|
|
**/
|
|
|
|
g_object_class_install_property
|
|
|
|
(object_class, PROP_STOPBITS,
|
|
|
|
g_param_spec_uint (NM_SETTING_SERIAL_STOPBITS, "", "",
|
|
|
|
1, 2, 1,
|
|
|
|
G_PARAM_READWRITE |
|
|
|
|
G_PARAM_CONSTRUCT |
|
|
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
|
|
|
|
/**
|
|
|
|
* NMSettingSerial:send-delay:
|
|
|
|
*
|
|
|
|
* Time to delay between each byte sent to the modem, in microseconds.
|
|
|
|
**/
|
|
|
|
g_object_class_install_property
|
|
|
|
(object_class, PROP_SEND_DELAY,
|
|
|
|
g_param_spec_uint64 (NM_SETTING_SERIAL_SEND_DELAY, "", "",
|
|
|
|
0, G_MAXUINT64, 0,
|
|
|
|
G_PARAM_READWRITE |
|
|
|
|
G_PARAM_CONSTRUCT |
|
|
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
}
|