fbconf_xorg/xf86/Device.c

/*
 *
 * Copyright (c) 1997  Metro Link Incorporated
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
 * OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *
 * Except as contained in this notice, the name of the Metro Link shall not be
 * used in advertising or otherwise to promote the sale, use or other dealings
 * in this Software without prior written authorization from Metro Link.
 *
 */
/*
 * Copyright (c) 1997-2003 by The XFree86 Project, Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * Except as contained in this notice, the name of the copyright holder(s)
 * and author(s) shall not be used in advertising or otherwise to promote
 * the sale, use or other dealings in this Software without prior written
 * authorization from the copyright holder(s) and author(s).
 */


/* View/edit this file with tab stops set to 4 */

#ifdef HAVE_XORG_CONFIG_H
#include <xorg-config.h>
#endif

#include "xf86Parser.h"
#include "xf86tokens.h"
#include "Configint.h"
#include "fields.h"     /* Config file output line fields */
#if defined(SMI_FBCONFIG)
#include "fbc_line_er.h"    /* External Representation of config lines */
#endif

extern LexRec val;

static
xf86ConfigSymTabRec DeviceTab[] =
{
    {ENDSECTION, "endsection"},
    {IDENTIFIER, "identifier"},
    {VENDOR, "vendorname"},
    {BOARD, "boardname"},
    {CHIPSET, "chipset"},
    {RAMDAC, "ramdac"},
    {DACSPEED, "dacspeed"},
    {CLOCKS, "clocks"},
    {OPTION, "option"},
    {VIDEORAM, "videoram"},
    {BIOSBASE, "biosbase"},
    {MEMBASE, "membase"},
    {IOBASE, "iobase"},
    {CLOCKCHIP, "clockchip"},
    {CHIPID, "chipid"},
    {CHIPREV, "chiprev"},
    {CARD, "card"},
    {DRIVER, "driver"},
    {BUSID, "busid"},
    {TEXTCLOCKFRQ, "textclockfreq"},
    {IRQ, "irq"},
    {SCREEN, "screen"},
    {-1, ""},
};

#define CLEANUP xf86freeDeviceList

XF86ConfDevicePtr
xf86parseDeviceSection (void)
{
    int i;
    int has_ident = FALSE;
    int token;
#if defined(SMI_FBCONFIG)
    void *line_er;      /* Ptr to Extnl Rep of config file line */
#endif
    parsePrologue (XF86ConfDevicePtr, XF86ConfDeviceRec)

    /* Zero is a valid value for these */
    ptr->dev_chipid = -1;
    ptr->dev_chiprev = -1;
    ptr->dev_irq = -1;
    for (;;)
    {
        token = xf86getToken(DeviceTab);
#if defined(SMI_FBCONFIG)
        /*
         * Get a ptr to the External Representation of this config line
         */
        line_er = fbc_get_current_line_ER();

#endif
        if (token == ENDSECTION)
        {
            break;
        }
        switch (token)
        {
        case COMMENT:
            ptr->dev_comment = xf86addComment(ptr->dev_comment, val.str);
            break;
        case IDENTIFIER:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Identifier");
            if (has_ident == TRUE)
                Error (MULTIPLE_MSG, "Identifier");
            ptr->dev_identifier = val.str;
            has_ident = TRUE;
            break;
        case VENDOR:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Vendor");
            ptr->dev_vendor = val.str;
            break;
        case BOARD:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Board");
            ptr->dev_board = val.str;
            break;
        case CHIPSET:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Chipset");
            ptr->dev_chipset = val.str;
            break;
        case CARD:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Card");
            ptr->dev_card = val.str;
            break;
        case DRIVER:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Driver");
            ptr->dev_driver = val.str;
            break;
        case RAMDAC:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "Ramdac");
            ptr->dev_ramdac = val.str;
            break;
        case DACSPEED:
            for (i = 0; i < CONF_MAXDACSPEEDS; i++)
                ptr->dev_dacSpeeds[i] = 0;
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
            {
                Error (DACSPEED_MSG, CONF_MAXDACSPEEDS);
            }
            else
            {
                ptr->dev_dacSpeeds[0] = (int) (val.realnum * 1000.0 + 0.5);
                for (i = 1; i < CONF_MAXDACSPEEDS; i++)
                {
                    if (xf86getSubToken (&(ptr->dev_comment)) == NUMBER)
                        ptr->dev_dacSpeeds[i] = (int)
                            (val.realnum * 1000.0 + 0.5);
                    else
                    {
                        xf86unGetToken (token);
                        break;
                    }
                }
            }
            break;
        case VIDEORAM:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "VideoRam");
            ptr->dev_videoram = val.num;
            break;
        case BIOSBASE:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "BIOSBase");
            ptr->dev_bios_base = val.num;
            break;
        case MEMBASE:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "MemBase");
            ptr->dev_mem_base = val.num;
            break;
        case IOBASE:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "IOBase");
            ptr->dev_io_base = val.num;
            break;
        case CLOCKCHIP:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "ClockChip");
            ptr->dev_clockchip = val.str;
            break;
        case CHIPID:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "ChipID");
            ptr->dev_chipid = val.num;
            break;
        case CHIPREV:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "ChipRev");
            ptr->dev_chiprev = val.num;
            break;

        case CLOCKS:
            token = xf86getSubToken(&(ptr->dev_comment));
            for( i = ptr->dev_clocks;
                token == NUMBER && i < CONF_MAXCLOCKS; i++ ) {
                ptr->dev_clock[i] = (int)(val.realnum * 1000.0 + 0.5);
                token = xf86getSubToken(&(ptr->dev_comment));
            }
            ptr->dev_clocks = i;
            xf86unGetToken (token);
            break;
        case TEXTCLOCKFRQ:
            if ((token = xf86getSubToken(&(ptr->dev_comment))) != NUMBER)
                Error (NUMBER_MSG, "TextClockFreq");
            ptr->dev_textclockfreq = (int)(val.realnum * 1000.0 + 0.5);
            break;
        case OPTION:
            ptr->dev_option_lst = xf86parseOption(ptr->dev_option_lst);
            break;
        case BUSID:
            if (xf86getSubToken (&(ptr->dev_comment)) != STRING)
                Error (QUOTE_MSG, "BusID");
            ptr->dev_busid = val.str;
            break;
        case IRQ:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (QUOTE_MSG, "IRQ");
            ptr->dev_irq = val.num;
            break;
        case SCREEN:
            if (xf86getSubToken (&(ptr->dev_comment)) != NUMBER)
                Error (NUMBER_MSG, "Screen");
            ptr->dev_screen = val.num;
            break;
        case EOF_TOKEN:
            Error (UNEXPECTED_EOF_MSG, NULL);
            break;
        default:
            Error (INVALID_KEYWORD_MSG, xf86tokenString ());
            break;
        }
    }

#if defined(SMI_FBCONFIG)
    /*
     * Link Internal & External Representations of the EndSection line
     */
    ptr->dev_end_line_er = line_er;
    fbc_link_line_ER(line_er,
            (void *)ptr,
            (xf86_print_fn_t *)&xf86printDeviceSectionEndSection,
            FBC_INDENT_0);

#endif
    if (!has_ident)
        Error (NO_IDENT_MSG, NULL);

#ifdef DEBUG
    printf ("Device section parsed\n");
#endif

    return ptr;
}

#undef CLEANUP


/*
 * xf86printDeviceSectionSection()
 *
 *    Write the Device section Section line to the configuration file.
 */
void
xf86printDeviceSectionSection(
    FILE *cf, XF86ConfDevicePtr ptr, const char *const whitespace[])
{
    fprintf (cf, "Section \"Device\"\n");
    if (ptr->dev_comment != NULL) {
        fprintf(cf, "%s", ptr->dev_comment);
    }
}


/*
 * xf86printDeviceSectionIdentifier()
 *
 *    Write the Device section Identifier line to the configuration
 *    file.
 */
void
xf86printDeviceSectionIdentifier(
    FILE *cf, XF86ConfDevicePtr ptr, const char *const whitespace[])
{
    xf86printFields(cf, whitespace, "Identifier", NULL);
    fprintf(cf, "\"%s\"\n", ptr->dev_identifier);
}


/*
 * xf86printDeviceSectionDriver()
 *
 *    Write the Device section Driver line to the configuration file.
 */
void
xf86printDeviceSectionDriver(
    FILE *cf, XF86ConfDevicePtr ptr, const char *const whitespace[])
{
    xf86printFields(cf, whitespace, "Driver", NULL);
    fprintf (cf, "\"%s\"\n", ptr->dev_driver);
}


/*
 * xf86printDeviceSectionVendorName()
 *
 *    Write the Device section VendorName line to the configuration
 *    file.
 */
void
xf86printDeviceSectionVendorName(
    FILE *cf, XF86ConfDevicePtr ptr, const char *const whitespace[])
{
    xf86printFields(cf, whitespace, "VendorName", NULL);
    fprintf (cf, "\"%s\"\n", ptr->dev_vendor);
}


/*
 * xf86printDeviceSectionBoardName()
 *
 *    Write the Device section BoardName line to the configuration file.
 */
void
xf86printDeviceSectionBoardName(
    FILE *cf, XF86ConfDevicePtr ptr, const char *const whitespace[])
{
    xf86printFields(cf, whitespace, "BoardName", NULL);
    fprintf (cf, "\"%s\"\n", ptr->dev_board);
}


/*
 * xf86printDeviceSectionEndSection()
 *
 *    Write the Device section EndSection line to the configuration
 *    file.
 */
void
xf86printDeviceSectionEndSection(
    FILE *cf, XF86ConfDevicePtr ptr, const char *const whitespace[])
{
    fprintf (cf, "EndSection\n");
}


/*
 * xf86printDeviceSection()
 *
 *    Write a Device section to the configuration file.
 */
void
xf86printDeviceSection (FILE * cf, XF86ConfDevicePtr ptr)
{
    int i;

    while (ptr)
    {
        xf86printDeviceSectionSection(cf, ptr, xf86whitespace_0);
        if (ptr->dev_identifier != NULL) {
            xf86printDeviceSectionIdentifier(cf, ptr, xf86whitespace_1);
        }
        if (ptr->dev_driver != NULL) {
            xf86printDeviceSectionDriver(cf, ptr, xf86whitespace_1);
        }
        if (ptr->dev_vendor != NULL) {
            xf86printDeviceSectionVendorName(cf, ptr, xf86whitespace_1);
        }
        if (ptr->dev_board != NULL) {
            xf86printDeviceSectionBoardName(cf, ptr, xf86whitespace_1);
        }
        if (ptr->dev_chipset)
            fprintf (cf, "\tChipSet     \"%s\"\n", ptr->dev_chipset);
        if (ptr->dev_card)
            fprintf (cf, "\tCard        \"%s\"\n", ptr->dev_card);
        if (ptr->dev_ramdac)
            fprintf (cf, "\tRamDac      \"%s\"\n", ptr->dev_ramdac);
        if (ptr->dev_dacSpeeds[0] > 0 ) {
            fprintf (cf, "\tDacSpeed    ");
            for (i = 0; i < CONF_MAXDACSPEEDS
                    && ptr->dev_dacSpeeds[i] > 0; i++ )
                fprintf (cf, "%g ", (double) (ptr->dev_dacSpeeds[i])/ 1000.0 );
            fprintf (cf, "\n");
        }
        if (ptr->dev_videoram)
            fprintf (cf, "\tVideoRam    %d\n", ptr->dev_videoram);
        if (ptr->dev_bios_base)
            fprintf (cf, "\tBiosBase    0x%lx\n", ptr->dev_bios_base);
        if (ptr->dev_mem_base)
            fprintf (cf, "\tMemBase     0x%lx\n", ptr->dev_mem_base);
        if (ptr->dev_io_base)
            fprintf (cf, "\tIOBase      0x%lx\n", ptr->dev_io_base);
        if (ptr->dev_clockchip)
            fprintf (cf, "\tClockChip   \"%s\"\n", ptr->dev_clockchip);
        if (ptr->dev_chipid != -1)
            fprintf (cf, "\tChipId      0x%x\n", ptr->dev_chipid);
        if (ptr->dev_chiprev != -1)
            fprintf (cf, "\tChipRev     0x%x\n", ptr->dev_chiprev);

        xf86printOptionList(cf, ptr->dev_option_lst, xf86whitespace_1);
        if (ptr->dev_clocks > 0 ) {
            fprintf (cf, "\tClocks      ");
            for (i = 0; i < ptr->dev_clocks; i++ )
                fprintf (cf, "%.1f ", (double)ptr->dev_clock[i] / 1000.0 );
            fprintf (cf, "\n");
        }
        if (ptr->dev_textclockfreq) {
            fprintf (cf, "\tTextClockFreq %.1f\n",
                     (double)ptr->dev_textclockfreq / 1000.0);
        }
        if (ptr->dev_busid)
            fprintf (cf, "\tBusID       \"%s\"\n", ptr->dev_busid);
        if (ptr->dev_screen > 0)
            fprintf (cf, "\tScreen      %d\n", ptr->dev_screen);
        if (ptr->dev_irq >= 0)
            fprintf (cf, "\tIRQ         %d\n", ptr->dev_irq);
        xf86printDeviceSectionEndSection(cf, ptr, xf86whitespace_0);
        fprintf (cf, "\n");
        ptr = ptr->list.next;
    }
}

void
xf86freeDeviceList (XF86ConfDevicePtr ptr)
{
    XF86ConfDevicePtr prev;

    while (ptr)
    {
        TestFree (ptr->dev_identifier);
        TestFree (ptr->dev_vendor);
        TestFree (ptr->dev_board);
        TestFree (ptr->dev_chipset);
        TestFree (ptr->dev_card);
        TestFree (ptr->dev_driver);
        TestFree (ptr->dev_ramdac);
        TestFree (ptr->dev_clockchip);
        TestFree (ptr->dev_comment);
        xf86optionListFree (ptr->dev_option_lst);

        prev = ptr;
        ptr = ptr->list.next;
        xf86conffree (prev);
    }
}

int
xf86validateDevice (XF86ConfigPtr p)
{
    XF86ConfDevicePtr device = p->conf_device_lst;

#if !defined(SMI_FBCONFIG)  /* Missing section will be constructed */
    if (!device) {
        xf86validationError ("At least one Device section is required.");
        return (FALSE);
    }

#endif
    while (device) {
        if (!device->dev_driver) {
            xf86validationError (UNDEFINED_DRIVER_MSG, device->dev_identifier);
            return (FALSE);
        }
        device = device->list.next;
    }
    return (TRUE);
}

XF86ConfDevicePtr
xf86findDevice (const char *ident, XF86ConfDevicePtr p)
{
    while (p)
    {
        if (xf86nameCompare (ident, p->dev_identifier) == 0)
            return (p);

        p = p->list.next;
    }
    return (NULL);
}

char *
xf86configStrdup (const char *s)
{
    char *tmp;
    if (!s) return NULL;
    tmp = xf86confmalloc (sizeof (char) * (strlen (s) + 1));
    if (tmp)
        strcpy (tmp, s);
    return (tmp);
}