summaryrefslogtreecommitdiff
path: root/sys/include/fs/ctlfs.h
blob: 90f42f0e3d090458a2420ec897b5b3bb1462d30b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
/*
 * Copyright (c) 2023-2025 Ian Marco Moffett and the Osmora Team.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of Hyra nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR CONTRIBUTORS 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.
 */

#ifndef _FS_CTLFS_H_
#define _FS_CTLFS_H_

#include <sys/sio.h>

struct ctlfs_dev;

struct ctlops {
    int(*read)(struct ctlfs_dev *cdp, struct sio_txn *sio);
    int(*write)(struct ctlfs_dev *cdp, struct sio_txn *sio);
};

/*
 * Ctlfs op arguments
 *
 * @devname: Device name.
 * @major: Device major
 * @minor: Device minor.
 * @mode: Access flags.
 * @devname [1]: Device name (node name)
 * @ctlname: [1]: Control name (node entry name)
 */
struct ctlfs_dev {
    union {
        const char *devname;
        const char *ctlname;
    };
    const struct ctlops *ops;
    mode_t mode;
};

int ctlfs_create_node(const char *name, const struct ctlfs_dev *dp);
int ctlfs_create_entry(const char *name, const struct ctlfs_dev *dp);

#endif  /* !_FS_CTLFS_H_ */