serdev_if.m revision 157990
11573Srgrimes#- 214272Spst# Copyright (c) 2006 Marcel Moolenaar 31573Srgrimes# All rights reserved. 41573Srgrimes# 51573Srgrimes# Redistribution and use in source and binary forms, with or without 61573Srgrimes# modification, are permitted provided that the following conditions 71573Srgrimes# are met: 81573Srgrimes# 1. Redistributions of source code must retain the above copyright 91573Srgrimes# notice, this list of conditions and the following disclaimer. 101573Srgrimes# 2. Redistributions in binary form must reproduce the above copyright 111573Srgrimes# notice, this list of conditions and the following disclaimer in the 121573Srgrimes# documentation and/or other materials provided with the distribution. 131573Srgrimes# 141573Srgrimes# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 151573Srgrimes# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 161573Srgrimes# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 171573Srgrimes# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 181573Srgrimes# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 191573Srgrimes# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 201573Srgrimes# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 211573Srgrimes# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 221573Srgrimes# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 231573Srgrimes# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 241573Srgrimes# SUCH DAMAGE. 251573Srgrimes# 261573Srgrimes# $FreeBSD: head/sys/kern/serdev_if.m 157990 2006-04-23 22:12:39Z marcel $ 271573Srgrimes# 281573Srgrimes 291573Srgrimes#include <sys/bus.h> 301573Srgrimes#include <sys/serial.h> 311573Srgrimes 321573Srgrimes# The serdev interface is used by umbrella drivers and children thereof to 331573Srgrimes# establish a more intimate relationship, necessary for efficient handling 341573Srgrimes# of multiple (concurrent) serial communication channels. Examples include 351573Srgrimes# serial communications controller (SCC) drivers, multi-I/O adapter drivers 361573Srgrimes# and intelligent multi-port serial drivers. Methods specifically deal 371573Srgrimes# with interrupt handling and configuration. Conceptually, the umbrella 3814272Spst# driver is responsible for the overall operation of the hardware and uses 391573Srgrimes# child drivers to handle each individual channel. 4092889Sobrien# The serdev interface is intended to inherit the device interface. 4192889Sobrien 421573SrgrimesINTERFACE serdev; 431573Srgrimes 441573Srgrimes# Default implementations of some methods. 4514272SpstCODE { 4614272Spst static serdev_intr_t * 4714272Spst default_ihand(device_t dev, int ipend) 481573Srgrimes { 4914272Spst return (NULL); 501573Srgrimes } 5192889Sobrien 521573Srgrimes static int 531573Srgrimes default_ipend(device_t dev) 541573Srgrimes { 551573Srgrimes return (-1); 561573Srgrimes } 57 58 static int 59 default_sysdev(device_t dev) 60 { 61 return (0); 62 } 63}; 64 65# ihand() - Query serial device interrupt handler. 66# This method is called by the umbrella driver to obtain function pointers 67# to interrupt handlers for each individual interrupt source. This allows 68# the umbralla driver to control the servicing of interrupts between the 69# different channels in the most flexible way. 70METHOD serdev_intr_t* ihand { 71 device_t dev; 72 int ipend; 73} DEFAULT default_ihand; 74 75# ipend() - Query pending interrupt status. 76# This method is called by the umbrella driver to obtain interrupt status 77# for the UART in question. This allows the umbrella driver to build a 78# matrix and service the interrupts in the most flexible way by calling 79# interrupt handlers collected with the ihand() method. 80METHOD int ipend { 81 device_t dev; 82} DEFAULT default_ipend; 83 84# sysdev() - Query system device status 85# This method may be called by the umbrella driver for each child driver 86# to establish if a particular channel and mode is currently being used 87# for system specific usage. If this is the case, the hardware is not 88# reset and the channel will not change its operation mode. 89# The return value is !0 if the channel and mode are used for a system 90# device and 0 otherwise. 91METHOD int sysdev { 92 device_t dev; 93} DEFAULT default_sysdev; 94 95