linux/drivers/watchdog/sch311x_wdt.c

// SPDX-License-Identifier: GPL-2.0+
/*
 *	sch311x_wdt.c - Driver for the SCH311x Super-I/O chips
 *			integrated watchdog.
 *
 *	(c) Copyright 2008 Wim Van Sebroeck <[email protected]>.
 *
 *	Neither Wim Van Sebroeck nor Iguana vzw. admit liability nor
 *	provide warranty for any of this software. This material is
 *	provided "AS-IS" and at no charge.
 */

/*
 *	Includes, defines, variables, module parameters, ...
 */

#define pr_fmt(fmt) …

/* Includes */
#include <linux/module.h>		/* For module specific items */
#include <linux/moduleparam.h>		/* For new moduleparam's */
#include <linux/types.h>		/* For standard types (like size_t) */
#include <linux/errno.h>		/* For the -ENODEV/... values */
#include <linux/kernel.h>		/* For printk/... */
#include <linux/miscdevice.h>		/* For struct miscdevice */
#include <linux/watchdog.h>		/* For the watchdog specific items */
#include <linux/init.h>			/* For __init/__exit/... */
#include <linux/fs.h>			/* For file operations */
#include <linux/platform_device.h>	/* For platform_driver framework */
#include <linux/ioport.h>		/* For io-port access */
#include <linux/spinlock.h>		/* For spin_lock/spin_unlock/... */
#include <linux/uaccess.h>		/* For copy_to_user/put_user/... */
#include <linux/io.h>			/* For inb/outb/... */

/* Module and version information */
#define DRV_NAME …

/* Runtime registers */
#define GP60 …
#define WDT_TIME_OUT …
#define WDT_VAL …
#define WDT_CFG …
#define WDT_CTRL …

/* internal variables */
static unsigned long sch311x_wdt_is_open;
static char sch311x_wdt_expect_close;
static struct platform_device *sch311x_wdt_pdev;

static int sch311x_ioports[] = …;

static struct { … } sch311x_wdt_data;

/* Module load parameters */
static unsigned short force_id;
module_param(force_id, ushort, 0);
MODULE_PARM_DESC(…) …;

#define WATCHDOG_TIMEOUT …
static int timeout = …;	/* in seconds */
module_param(timeout, int, 0);
MODULE_PARM_DESC(…) …;

static bool nowayout = … WATCHDOG_NOWAYOUT;
module_param(nowayout, bool, 0);
MODULE_PARM_DESC(…) …;

/*
 *	Super-IO functions
 */

static inline void sch311x_sio_enter(int sio_config_port)
{ … }

static inline void sch311x_sio_exit(int sio_config_port)
{ … }

static inline int sch311x_sio_inb(int sio_config_port, int reg)
{ … }

static inline void sch311x_sio_outb(int sio_config_port, int reg, int val)
{ … }

/*
 *	Watchdog Operations
 */

static void sch311x_wdt_set_timeout(int t)
{ … }

static void sch311x_wdt_start(void)
{ … }

static void sch311x_wdt_stop(void)
{ … }

static void sch311x_wdt_keepalive(void)
{ … }

static int sch311x_wdt_set_heartbeat(int t)
{ … }

static void sch311x_wdt_get_status(int *status)
{ … }

/*
 *	/dev/watchdog handling
 */

static ssize_t sch311x_wdt_write(struct file *file, const char __user *buf,
						size_t count, loff_t *ppos)
{ … }

static long sch311x_wdt_ioctl(struct file *file, unsigned int cmd,
							unsigned long arg)
{ … }

static int sch311x_wdt_open(struct inode *inode, struct file *file)
{ … }

static int sch311x_wdt_close(struct inode *inode, struct file *file)
{ … }

/*
 *	Kernel Interfaces
 */

static const struct file_operations sch311x_wdt_fops = …;

static struct miscdevice sch311x_wdt_miscdev = …;

/*
 *	Init & exit routines
 */

static int sch311x_wdt_probe(struct platform_device *pdev)
{ … }

static void sch311x_wdt_remove(struct platform_device *pdev)
{ … }

static void sch311x_wdt_shutdown(struct platform_device *dev)
{ … }

static struct platform_driver sch311x_wdt_driver = …;

static int __init sch311x_detect(int sio_config_port, unsigned short *addr)
{ … }

static int __init sch311x_wdt_init(void)
{ … }

static void __exit sch311x_wdt_exit(void)
{ … }

module_init(…) …;
module_exit(sch311x_wdt_exit);

MODULE_AUTHOR(…) …;
MODULE_DESCRIPTION(…) …;
MODULE_LICENSE(…) …;