HelenOS sources

root/uspace/lib/device/src/io/serial.c

/* [<][>][^][v][top][bottom][index][help] */

DEFINITIONS

This source file includes following definitions.
  1. serial_open
  2. serial_close
  3. serial_set_comm_props
  4. serial_get_comm_props

/*
 * Copyright (c) 2017 Jiri Svoboda
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - 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.
 * - 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 <async.h>
#include <errno.h>
#include <io/serial.h>
#include <ipc/serial_ctl.h>
#include <ipc/services.h>
#include <stdlib.h>

/** Open serial port device.
 *
 * @param sess Session with the serial port device
 * @param rchardev Place to store pointer to the new serial port device structure
 *
 * @return EOK on success, ENOMEM if out of memory, EIO on I/O error
 */
errno_t serial_open(async_sess_t *sess, serial_t **rserial)
{
        serial_t *serial;

        serial = calloc(1, sizeof(serial_t));
        if (serial == NULL)
                return ENOMEM;

        serial->sess = sess;
        *rserial = serial;

        return EOK;
}

/** Close serial port device.
 *
 * Frees the serial port device structure. The underlying session is
 * not affected.
 *
 * @param serial Serial port device or @c NULL
 */
void serial_close(serial_t *serial)
{
        free(serial);
}

/** Set serial port communication properties. */
errno_t serial_set_comm_props(serial_t *serial, unsigned rate,
    serial_parity_t parity, unsigned datab, unsigned stopb)
{
        async_exch_t *exch = async_exchange_begin(serial->sess);

        errno_t rc = async_req_4_0(exch, SERIAL_SET_COM_PROPS, rate, parity,
            datab, stopb);

        async_exchange_end(exch);
        return rc;
}

/** Get serial port communication properties. */
errno_t serial_get_comm_props(serial_t *serial, unsigned *rrate,
    serial_parity_t *rparity, unsigned *rdatab, unsigned *rstopb)
{
        async_exch_t *exch = async_exchange_begin(serial->sess);
        sysarg_t rate, parity, datab, stopb;

        errno_t rc = async_req_0_4(exch, SERIAL_GET_COM_PROPS, &rate, &parity,
            &datab, &stopb);

        async_exchange_end(exch);
        if (rc != EOK)
                return rc;

        *rrate = rate;
        *rparity = parity;
        *rdatab = datab;
        *rstopb = stopb;

        return EOK;
}

/** @}
 */

/* [<][>][^][v][top][bottom][index][help] */
HelenOS homepage, sources at GitHub