blob: 15f18fe98e23693b3adf1f8ac024addfac514ab1 [file] [log] [blame]
/*
* hdhomerun_control.c
*
* Copyright © 2006-2010 Silicondust USA Inc. <www.silicondust.com>.
*
* 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 3 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, see <http://www.gnu.org/licenses/>.
*
* As a special exception to the GNU Lesser General Public License,
* you may link, statically or dynamically, an application with a
* publicly distributed version of the Library to produce an
* executable file containing portions of the Library, and
* distribute that executable file under terms of your choice,
* without any of the additional requirements listed in clause 4 of
* the GNU Lesser General Public License.
*
* By "a publicly distributed version of the Library", we mean
* either the unmodified Library as distributed by Silicondust, or a
* modified version of the Library that is distributed under the
* conditions defined in the GNU Lesser General Public License.
*/
#include "hdhomerun.h"
#define HDHOMERUN_CONTROL_CONNECT_TIMEOUT 2500
#define HDHOMERUN_CONTROL_SEND_TIMEOUT 2500
#define HDHOMERUN_CONTROL_RECV_TIMEOUT 2500
#define HDHOMERUN_CONTROL_UPGRADE_TIMEOUT 20000
struct hdhomerun_control_sock_t {
uint32_t desired_device_id;
uint32_t desired_device_ip;
uint32_t actual_device_id;
uint32_t actual_device_ip;
hdhomerun_sock_t sock;
struct hdhomerun_debug_t *dbg;
struct hdhomerun_pkt_t tx_pkt;
struct hdhomerun_pkt_t rx_pkt;
};
static void hdhomerun_control_close_sock(struct hdhomerun_control_sock_t *cs)
{
if (cs->sock == HDHOMERUN_SOCK_INVALID) {
return;
}
hdhomerun_sock_destroy(cs->sock);
cs->sock = HDHOMERUN_SOCK_INVALID;
}
void hdhomerun_control_set_device(struct hdhomerun_control_sock_t *cs, uint32_t device_id, uint32_t device_ip)
{
hdhomerun_control_close_sock(cs);
cs->desired_device_id = device_id;
cs->desired_device_ip = device_ip;
cs->actual_device_id = 0;
cs->actual_device_ip = 0;
}
struct hdhomerun_control_sock_t *hdhomerun_control_create(uint32_t device_id, uint32_t device_ip, struct hdhomerun_debug_t *dbg)
{
struct hdhomerun_control_sock_t *cs = (struct hdhomerun_control_sock_t *)calloc(1, sizeof(struct hdhomerun_control_sock_t));
if (!cs) {
hdhomerun_debug_printf(dbg, "hdhomerun_control_create: failed to allocate control object\n");
return NULL;
}
cs->dbg = dbg;
cs->sock = HDHOMERUN_SOCK_INVALID;
hdhomerun_control_set_device(cs, device_id, device_ip);
return cs;
}
void hdhomerun_control_destroy(struct hdhomerun_control_sock_t *cs)
{
hdhomerun_control_close_sock(cs);
free(cs);
}
static bool_t hdhomerun_control_connect_sock(struct hdhomerun_control_sock_t *cs)
{
if (cs->sock != HDHOMERUN_SOCK_INVALID) {
return TRUE;
}
if ((cs->desired_device_id == 0) && (cs->desired_device_ip == 0)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_connect_sock: no device specified\n");
return FALSE;
}
if (hdhomerun_discover_is_ip_multicast(cs->desired_device_ip)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_connect_sock: cannot use multicast ip address for device operations\n");
return FALSE;
}
/* Find device. */
struct hdhomerun_discover_device_t result;
if (hdhomerun_discover_find_devices_custom(cs->desired_device_ip, HDHOMERUN_DEVICE_TYPE_WILDCARD, cs->desired_device_id, &result, 1) <= 0) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_connect_sock: device not found\n");
return FALSE;
}
cs->actual_device_ip = result.ip_addr;
cs->actual_device_id = result.device_id;
/* Create socket. */
cs->sock = hdhomerun_sock_create_tcp();
if (cs->sock == HDHOMERUN_SOCK_INVALID) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_connect_sock: failed to create socket (%d)\n", hdhomerun_sock_getlasterror());
return FALSE;
}
/* Initiate connection. */
if (!hdhomerun_sock_connect(cs->sock, cs->actual_device_ip, HDHOMERUN_CONTROL_TCP_PORT, HDHOMERUN_CONTROL_CONNECT_TIMEOUT)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_connect_sock: failed to connect (%d)\n", hdhomerun_sock_getlasterror());
hdhomerun_control_close_sock(cs);
return FALSE;
}
/* Success. */
return TRUE;
}
uint32_t hdhomerun_control_get_device_id(struct hdhomerun_control_sock_t *cs)
{
if (!hdhomerun_control_connect_sock(cs)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_device_id: connect failed\n");
return 0;
}
return cs->actual_device_id;
}
uint32_t hdhomerun_control_get_device_ip(struct hdhomerun_control_sock_t *cs)
{
if (!hdhomerun_control_connect_sock(cs)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_device_ip: connect failed\n");
return 0;
}
return cs->actual_device_ip;
}
uint32_t hdhomerun_control_get_device_id_requested(struct hdhomerun_control_sock_t *cs)
{
return cs->desired_device_id;
}
uint32_t hdhomerun_control_get_device_ip_requested(struct hdhomerun_control_sock_t *cs)
{
return cs->desired_device_ip;
}
uint32_t hdhomerun_control_get_local_addr(struct hdhomerun_control_sock_t *cs)
{
if (!hdhomerun_control_connect_sock(cs)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_local_addr: connect failed\n");
return 0;
}
uint32_t addr = hdhomerun_sock_getsockname_addr(cs->sock);
if (addr == 0) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_local_addr: getsockname failed (%d)\n", hdhomerun_sock_getlasterror());
return 0;
}
return addr;
}
static bool_t hdhomerun_control_send_sock(struct hdhomerun_control_sock_t *cs, struct hdhomerun_pkt_t *tx_pkt)
{
if (!hdhomerun_sock_send(cs->sock, tx_pkt->start, tx_pkt->end - tx_pkt->start, HDHOMERUN_CONTROL_SEND_TIMEOUT)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_send_sock: send failed (%d)\n", hdhomerun_sock_getlasterror());
hdhomerun_control_close_sock(cs);
return FALSE;
}
return TRUE;
}
static bool_t hdhomerun_control_recv_sock(struct hdhomerun_control_sock_t *cs, struct hdhomerun_pkt_t *rx_pkt, uint16_t *ptype, uint64_t recv_timeout)
{
uint64_t stop_time = getcurrenttime() + recv_timeout;
hdhomerun_pkt_reset(rx_pkt);
while (1) {
uint64_t current_time = getcurrenttime();
if (current_time >= stop_time) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_recv_sock: timeout\n");
hdhomerun_control_close_sock(cs);
return FALSE;
}
size_t length = rx_pkt->limit - rx_pkt->end;
if (!hdhomerun_sock_recv(cs->sock, rx_pkt->end, &length, stop_time - current_time)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_recv_sock: recv failed (%d)\n", hdhomerun_sock_getlasterror());
hdhomerun_control_close_sock(cs);
return FALSE;
}
rx_pkt->end += length;
int ret = hdhomerun_pkt_open_frame(rx_pkt, ptype);
if (ret < 0) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_recv_sock: frame error\n");
hdhomerun_control_close_sock(cs);
return FALSE;
}
if (ret > 0) {
return TRUE;
}
}
}
static int hdhomerun_control_send_recv_internal(struct hdhomerun_control_sock_t *cs, struct hdhomerun_pkt_t *tx_pkt, struct hdhomerun_pkt_t *rx_pkt, uint16_t type, uint64_t recv_timeout)
{
hdhomerun_pkt_seal_frame(tx_pkt, type);
int i;
for (i = 0; i < 2; i++) {
if (cs->sock == HDHOMERUN_SOCK_INVALID) {
if (!hdhomerun_control_connect_sock(cs)) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_send_recv: connect failed\n");
return -1;
}
}
if (!hdhomerun_control_send_sock(cs, tx_pkt)) {
continue;
}
if (!rx_pkt) {
return 1;
}
uint16_t rsp_type;
if (!hdhomerun_control_recv_sock(cs, rx_pkt, &rsp_type, recv_timeout)) {
continue;
}
if (rsp_type != type + 1) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_send_recv: unexpected frame type\n");
hdhomerun_control_close_sock(cs);
continue;
}
return 1;
}
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_send_recv: failed\n");
return -1;
}
int hdhomerun_control_send_recv(struct hdhomerun_control_sock_t *cs, struct hdhomerun_pkt_t *tx_pkt, struct hdhomerun_pkt_t *rx_pkt, uint16_t type)
{
return hdhomerun_control_send_recv_internal(cs, tx_pkt, rx_pkt, type, HDHOMERUN_CONTROL_RECV_TIMEOUT);
}
static int hdhomerun_control_get_set(struct hdhomerun_control_sock_t *cs, const char *name, const char *value, uint32_t lockkey, char **pvalue, char **perror)
{
struct hdhomerun_pkt_t *tx_pkt = &cs->tx_pkt;
struct hdhomerun_pkt_t *rx_pkt = &cs->rx_pkt;
/* Request. */
hdhomerun_pkt_reset(tx_pkt);
int name_len = (int)strlen(name) + 1;
if (tx_pkt->end + 3 + name_len > tx_pkt->limit) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_set: request too long\n");
return -1;
}
hdhomerun_pkt_write_u8(tx_pkt, HDHOMERUN_TAG_GETSET_NAME);
hdhomerun_pkt_write_var_length(tx_pkt, name_len);
hdhomerun_pkt_write_mem(tx_pkt, (const void *)name, name_len);
if (value) {
int value_len = (int)strlen(value) + 1;
if (tx_pkt->end + 3 + value_len > tx_pkt->limit) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_set: request too long\n");
return -1;
}
hdhomerun_pkt_write_u8(tx_pkt, HDHOMERUN_TAG_GETSET_VALUE);
hdhomerun_pkt_write_var_length(tx_pkt, value_len);
hdhomerun_pkt_write_mem(tx_pkt, (const void *)value, value_len);
}
if (lockkey != 0) {
if (tx_pkt->end + 6 > tx_pkt->limit) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_set: request too long\n");
return -1;
}
hdhomerun_pkt_write_u8(tx_pkt, HDHOMERUN_TAG_GETSET_LOCKKEY);
hdhomerun_pkt_write_var_length(tx_pkt, 4);
hdhomerun_pkt_write_u32(tx_pkt, lockkey);
}
/* Send/Recv. */
if (hdhomerun_control_send_recv_internal(cs, tx_pkt, rx_pkt, HDHOMERUN_TYPE_GETSET_REQ, HDHOMERUN_CONTROL_RECV_TIMEOUT) < 0) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_set: send/recv error\n");
return -1;
}
/* Response. */
while (1) {
uint8_t tag;
size_t len;
uint8_t *next = hdhomerun_pkt_read_tlv(rx_pkt, &tag, &len);
if (!next) {
break;
}
switch (tag) {
case HDHOMERUN_TAG_GETSET_VALUE:
if (pvalue) {
*pvalue = (char *)rx_pkt->pos;
rx_pkt->pos[len] = 0;
}
if (perror) {
*perror = NULL;
}
return 1;
case HDHOMERUN_TAG_ERROR_MESSAGE:
rx_pkt->pos[len] = 0;
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_set: %s\n", rx_pkt->pos);
if (pvalue) {
*pvalue = NULL;
}
if (perror) {
*perror = (char *)rx_pkt->pos;
}
return 0;
}
rx_pkt->pos = next;
}
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_get_set: missing response tags\n");
return -1;
}
int hdhomerun_control_get(struct hdhomerun_control_sock_t *cs, const char *name, char **pvalue, char **perror)
{
return hdhomerun_control_get_set(cs, name, NULL, 0, pvalue, perror);
}
int hdhomerun_control_set(struct hdhomerun_control_sock_t *cs, const char *name, const char *value, char **pvalue, char **perror)
{
return hdhomerun_control_get_set(cs, name, value, 0, pvalue, perror);
}
int hdhomerun_control_set_with_lockkey(struct hdhomerun_control_sock_t *cs, const char *name, const char *value, uint32_t lockkey, char **pvalue, char **perror)
{
return hdhomerun_control_get_set(cs, name, value, lockkey, pvalue, perror);
}
int hdhomerun_control_upgrade(struct hdhomerun_control_sock_t *cs, FILE *upgrade_file)
{
struct hdhomerun_pkt_t *tx_pkt = &cs->tx_pkt;
struct hdhomerun_pkt_t *rx_pkt = &cs->rx_pkt;
bool_t upload_delay = FALSE;
uint32_t sequence = 0;
/* Special case detection. */
char *version_str;
int ret = hdhomerun_control_get(cs, "/sys/version", &version_str, NULL);
if (ret > 0) {
upload_delay = strcmp(version_str, "20120704beta1") == 0;
}
/* Upload. */
while (1) {
uint8_t data[256];
size_t length = fread(data, 1, 256, upgrade_file);
if (length == 0) {
break;
}
hdhomerun_pkt_reset(tx_pkt);
hdhomerun_pkt_write_u32(tx_pkt, sequence);
hdhomerun_pkt_write_mem(tx_pkt, data, length);
if (hdhomerun_control_send_recv_internal(cs, tx_pkt, NULL, HDHOMERUN_TYPE_UPGRADE_REQ, 0) < 0) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_upgrade: send/recv failed\n");
return -1;
}
sequence += (uint32_t)length;
if (upload_delay) {
msleep_approx(25);
}
}
if (sequence == 0) {
/* No data in file. Error, but no need to close connection. */
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_upgrade: zero length file\n");
return 0;
}
/* Execute upgrade. */
hdhomerun_pkt_reset(tx_pkt);
hdhomerun_pkt_write_u32(tx_pkt, 0xFFFFFFFF);
if (hdhomerun_control_send_recv_internal(cs, tx_pkt, rx_pkt, HDHOMERUN_TYPE_UPGRADE_REQ, HDHOMERUN_CONTROL_UPGRADE_TIMEOUT) < 0) {
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_upgrade: send/recv failed\n");
return -1;
}
/* Check response. */
while (1) {
uint8_t tag;
size_t len;
uint8_t *next = hdhomerun_pkt_read_tlv(rx_pkt, &tag, &len);
if (!next) {
break;
}
switch (tag) {
case HDHOMERUN_TAG_ERROR_MESSAGE:
rx_pkt->pos[len] = 0;
hdhomerun_debug_printf(cs->dbg, "hdhomerun_control_upgrade: %s\n", (char *)rx_pkt->pos);
return 0;
default:
break;
}
rx_pkt->pos = next;
}
return 1;
}