syswindml.c

WindML BSP specific routines

/* sysWindML.c - WindML BSP specific routines  */

/* Copyright 2002 Wind River Systems, Inc. */

#include "copyright_wrs.h"
/*
modification history
--------------------
*/

/* includes */

#include "vxWorks.h"
#include "memLib.h"
#include "ugl/sysWindML.h"
#include "config.h"

/*
DESCRIPTION

This library provides board-specific routines to support WindML.  This file is 
included at the end of sysLib.c when WindML functionality is to be included.

This API is designed in a general fashion, such that it is applicable to all
processor types and is bus independent.  NOTE: this particular file
provides for graphics devices that are integral to a processor (such as with
the PPC823).

The API provides support for configurations where a system has multiple graphics
devices and input devices.

A data structure allocated within the BSP provides information describing the 
graphics, input (keyboard and pointer), and audio devices.  A serial pointer
that connects to a standard serial port (such as, /tyCo/0) is not covered by
this API.  Those devices use the standard serial drivers.

The data structure to define the graphics device is as follows:

\cs
 typedef struct windml_device
     {
    unsigned int        vendorID;  /@ vendor ID @/
    unsigned int        deviceID;  /@ device ID @/
    unsigned int        instance;  /@ instance of device @/
    unsigned int        devType;   /@ type of input device @/
    unsigned int        busType;   /@ type of bus @/
    unsigned int        regDelta;  /@ distance between adjacent registers @/
    unsigned int        intLevel;  /@ interrupt level to be used @/
    void        (** intVector)();  /@ interrupt vector @/ 
    void *      pPhysBaseAdrs0;    /@ first base address @/
    void *      pPhysBaseAdrs1;    /@ second base address @/
    void *      pPhysBaseAdrs2;    /@ third base address @/
    void *      pPhysBaseAdrs3;    /@ fourth base address @/
    void *      pPhysBaseAdrs4;    /@ fifth base address @/
    void *      pPhysBaseAdrs5;    /@ sixth base address @/
    void *      pRegBase;          /@ base address of legacy register space @/
     } WINDML_DEVICE;
\ce

 The <vendorID> and the <deviceID> are based upon the PCI bus identifiers.  In
 this case, these identifiers are extended to include the mapping for non-PCI
 devices.  The file sysWindML.h provides the identifier for supported vendor
 and device identifiers.
 
 The above structure supports devices with up to six base addresses used
 to access the device (for example, one base address for the frame buffer
 and another for the memory mapped registers).  Typically, a device 
 will only have a base address.  The <pPhysBaseAdrsX> may need to be interpreted
 based upon the busType (for example, the <pPhysBaseAdrsX> value is directly
 obtained from the PCI header which includes flag bits unrelated to the address
 value).

 The <pRegBase> field identifies the base address to use to access the I/O ports.
 This is typically the base of the ISA space.  For X86 type processors, this
 field would be set to 0.  For powerPC processors, this field would be set 
 according to the memory model used (PReP or CHRP).  The <regDelta> value only
 applies to this legacy register space.

INCLUDE FILES: ugl/sysWindML.h
*/

#ifndef KHEAP_ALLOC
#   define KHEAP_ALLOC malloc
#endif /* KHEAP_ALLOC */
#ifndef KHEAP_FREE
#   define KHEAP_FREE free
#endif /* KHEAP_FREE */


/*******************************************************************************
*
* sysWindMLDevGet - configures the device
*
* This routine will determine the presence of the device and perform any device 
* configuration required.  The behaviour of this function varies depending on the 
* type of device configuration (such as a PCI device, integral, device 
* controller, etc.).  A device configuration data structure is created for the 
* specified device.  This configuration data defines the access mechanism for 
* the device.    
*
* The <vendorID> and <deviceID> identify the vendor and device identifiers
* in the PCI environment.  In the case of non-PCI type devices, these
* identifiers provide identifiers of the device outside of the range of PCI
* identifiers.  If these values are set to zero, then the <instance>
* occurrence of a device will be returned.  For example, if the <instance>
* and <vendorID> were set to zero, then the routine will return the first
* occurrence of a device.
* 
* The returned data structure provides miscellaneous data items that describe 
* the manner in which to access the device.  
*
* RETURNS:
* When device has been successfully configured, the address of the
* device data structure; otherwise NULL
*/

WINDML_DEVICE * sysWindMLDevGet 
    (
    UINT32 devType,     /* Device Type */
    UINT32 instance,    /* The instance of the device */
    UINT32 vendorID,    /* The identifier for the device manufacturer */
    UINT32 deviceID     /* The identifier for the device */
    )
    {

    WINDML_DEVICE * pDev = NULL;

    switch (devType)
        {
        case WINDML_KEYBOARD_DEVICE:
            {
            pDev = (WINDML_DEVICE *)KHEAP_ALLOC(sizeof(WINDML_DEVICE));
            bzero ((char *)pDev,sizeof(WINDML_DEVICE));
            if (pDev == NULL)
                return(pDev);

            pDev->devType = devType;
            pDev->regDelta = 4;
            pDev->intLevel = IVEC_TO_ILVL(IV_KEYBOARD);
            pDev->intVector = (VOIDFUNCPTR *)IV_KEYBOARD;
            pDev->pRegBase = (void *)CPU_ISA_KBD_DATA;
            pDev->busType = BUS_TYPE_NONE;

            break;
            }

        case WINDML_POINTER_DEVICE :
            {
            pDev = (WINDML_DEVICE *)KHEAP_ALLOC(sizeof(WINDML_DEVICE));
            bzero ((char *)pDev,sizeof(WINDML_DEVICE));
            if (pDev == NULL)
                return (pDev);

            pDev->devType = devType;
            pDev->regDelta = 4;
            pDev->intLevel = IVEC_TO_ILVL(IV_MOUSE);
            pDev->intVector = (VOIDFUNCPTR *)IV_MOUSE;
            pDev->pRegBase = (void *)CPU_ISA_KBD_DATA;
            pDev->busType = BUS_TYPE_NONE;

            break;
            }

        default:
                break;
        }
    return(pDev);
}

/*******************************************************************************
*
* sysWindMLDevCtrl - special control of the device mode
*
* This routine provides special control features for the device.  This
* function is essentially a catch all to provide control of the device
* where the functionality is provided within a PCI configuration header or
* by board specific registers which may be shared by other functions implemented
* on the target board.
*
* The <function> argument defines the type of function that is to be
* performed and the <pArg> parameter provides the details relating to the
* function. 
*
* The values for <function> and the interpretation of the <pArg> parameters
* are:
*
*\is
*\i WINDML_ACCESS_MODE_SET
*       Sets the device's access mode as to whether it is to respond to I/O
*       cycles of memory mapped cycles or both.  The accessibility is
*       provided by the <pArg> parameter which is bit mapped containing the
*       flags WINDML_MEM_ENABLE (enable memory mapped access) and
*       WINDML_IO_ENABLE (enable I/O access).
*\i WINDML_LCD_MODE_SET
*       Sets the control mode for an LCD that is controllable by an on board
*       register rather than a graphics device register. The mode information
*       is passed through <pArg>. The flags available are WINDML_LCD_ON
*       WINDML_LCD_OFF, WINDML_BACKLIGHT_ON, WINDML_BACKLIGHT_OFF.
*\i WINDML_BUSWIDTH_SET
*       Some boards allow the LCD bus width to be changed dynamically via
*       an FPGA or other configurable logic. This can be done in a board
*       specific manner. The actual bus width will be passed through <pArg>.
*\i WINDML_PCI_MEMBASE_GET
*       Obtain the base address of CPU memory as seen by PCI devices.  
*\ie
*
* RETURNS: OK when control operation was success; otherwise ERROR
*/
STATUS sysWindMLDevCtrl 
    (
    WINDML_DEVICE * pDev,        /* Device to control */
    int             function,    /* Type of operation to perform */
    int *           pArg         /* Control mode */
    )
    {
    /* 
     * Typical sysWindMLDevCtrl() code only works with PCI which is not
     * supported here.
     */
    return (ERROR);
    }

/*******************************************************************************
*
* sysWindMLDevRelease - release a device configuration
*
* This routine will release any resources that were allocated when a  
* device was configured using the <sysWindMLDevGet()> function.  This 
* function will free the memory that was allocated for the WINDML_DEVICE 
* data structure if it was dynamically allocated.  If the data structure
* was not dynamically allocated, this function will usually be simply a
* stub.
*
* RETURNS: OK when operation was success; otherwise ERROR
*/
STATUS sysWindMLDevRelease 
    (
    WINDML_DEVICE * pDev         /* Device to release */
    )
    {
    if (pDev != NULL)
        {
        KHEAP_FREE ((char *) pDev);
        }

    return (OK);
    }

/*******************************************************************************
*
* sysWindMLIntConnect - Connect the device interrupt.
*
* This routine connects a routine to the interrupt.
*
* RETURNS: OK or ERROR
*/
STATUS sysWindMLIntConnect
    (
    WINDML_DEVICE * pDev,        /* Graphics device to control */
    VOIDFUNCPTR     routine,     /* routine to be called */
    int             parameter    /* parameter to be passed */
    )
    {
    STATUS status = ERROR;

    if (pDev != NULL && pDev->intVector != NULL && routine != NULL)
        {
        status = intConnect (pDev->intVector, routine, parameter);
        }
    return (status);
    }

/*******************************************************************************
*
* sysWindMLIntEnable - Enable interrupts.
*
* This routine enables the interrupt.
*
* RETURNS: OK or ERROR
*/
STATUS sysWindMLIntEnable
    (
    WINDML_DEVICE * pDev         /* Device to control */
    )
    {
    STATUS status = ERROR;

    if (pDev != NULL && pDev->intLevel != 0)
        {
        status = sysIntEnablePIC (IVEC_TO_INUM(pDev->intLevel));
        }

    return (status);
    }

/*******************************************************************************
*
* sysWindMLIntDisable - Disable interrupts.
*
* This routine does not disable the interrupt on the MBX 860 BSP because there
* is no BSP API call to do it.
*
* RETURNS: ERROR
*/
STATUS sysWindMLIntDisable
    (
    WINDML_DEVICE * pDev         /* Device to control */
    )
    {
    return (ERROR);
    }