XenevaOS
Loading...
Searching...
No Matches
Classes | Macros | Typedefs | Enumerations | Functions
core.h File Reference
#include <stdint.h>
#include <aurora.h>
Include dependency graph for core.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  _bordoisila_drvcore_res_
 
struct  _bordoisila_driver_
 

Macros

#define BORDOISILA_DRIVER_RES_CLK   0
 
#define BORDOISILA_DRIVER_RES_GATE   1
 
#define BORDOISILA_DRIVER_RES_POWER   2
 
#define BORDOISILA_DRIVER_RES_REGULATOR   3
 
#define BORDOISILA_DRIVER_RES_PIN   4
 
#define BORDOISILA_DRIVER_RES_BUS   5
 
#define BORDOISILA_DRIVER_ALREADY_REGISTERED   -2
 
#define B_DRIVER_STATE_PROBED   0
 
#define B_DRIVER_STATE_FAILED   1
 
#define B_DRIVER_STATE_UNBOUND   2
 

Typedefs

typedef struct _bordoisila_drvcore_res_ BordoisilaDriverResource
 
typedef struct _bordoisila_driver_ BordoisilaDriver
 

Enumerations

enum  driver_type { BORDOISILA_DRIVER_NORMAL , BORDOISILA_DRIVER_BUS_I2C , BORDOISILA_DRIVER_BUS_SPI , BORDOISILA_DRIVER_BUS_USB }
 

Functions

AU_EXTERN AU_EXPORT int BordoisilaDriverRegister (BordoisilaDriver *driver)
 BordoisilaDriverRegister – register a driver to core registry.
 
AU_EXTERN AU_EXPORT BordoisilaDriver * BordoisilaGetDriverByCompat (char *compat)
 BordoisilaGetDriverByCompat – match a driver by its compat string.
 
AU_EXTERN AU_EXPORT BordoisilaDriver * BordoisilaGetDriverByName (char *name)
 BordoisilaGetDriverByName – match a driver by its name.
 
void BordoisilaDriverProbeAll ()
 BordoisilaDriverProbeAll – start probing all driver registered.
 
AU_EXTERN AU_EXPORT int BordoisilaDriverScan (BordoisilaDriver *driver)
 BordoisilaDriverScan – scan a bus, only applicable if the driver is a bus.
 
AU_EXTERN AU_EXPORT int BordoisilaDriverProbe (BordoisilaDriver *driver)
 
AU_EXTERN AU_EXPORT int BordoisilaDriverRemove (BordoisilaDriver *driver)
 BordoisilaDriverRemove – remove a driver doesn't mean it could be removed from memory, calling remove cleans up driver's allocated resources, and decreaments internal reference count of driver resources it was using like (Clk, Regulator, Pin etc), also if the driver is shared between different module, before calling remove just decrement reference count.
 
AU_EXTERN AU_EXPORT int BordoisilaDriverSuspend (BordoisilaDriver *driver)
 
AU_EXTERN AU_EXPORT int BordoisilaDriverResume (BordoisilaDriver *driver)
 

Detailed Description

BSD 2-Clause License

Copyright (c) 2022-2026, Manas Kamal Choudhury 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.

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 HOLDER 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.

Macro Definition Documentation

◆ B_DRIVER_STATE_FAILED

#define B_DRIVER_STATE_FAILED   1

◆ B_DRIVER_STATE_PROBED

#define B_DRIVER_STATE_PROBED   0

◆ B_DRIVER_STATE_UNBOUND

#define B_DRIVER_STATE_UNBOUND   2

◆ BORDOISILA_DRIVER_ALREADY_REGISTERED

#define BORDOISILA_DRIVER_ALREADY_REGISTERED   -2

◆ BORDOISILA_DRIVER_RES_BUS

#define BORDOISILA_DRIVER_RES_BUS   5

◆ BORDOISILA_DRIVER_RES_CLK

#define BORDOISILA_DRIVER_RES_CLK   0

◆ BORDOISILA_DRIVER_RES_GATE

#define BORDOISILA_DRIVER_RES_GATE   1

◆ BORDOISILA_DRIVER_RES_PIN

#define BORDOISILA_DRIVER_RES_PIN   4

◆ BORDOISILA_DRIVER_RES_POWER

#define BORDOISILA_DRIVER_RES_POWER   2

◆ BORDOISILA_DRIVER_RES_REGULATOR

#define BORDOISILA_DRIVER_RES_REGULATOR   3

Typedef Documentation

◆ BordoisilaDriver

typedef struct _bordoisila_driver_ BordoisilaDriver

◆ BordoisilaDriverResource

typedef struct _bordoisila_drvcore_res_ BordoisilaDriverResource

Enumeration Type Documentation

◆ driver_type

enum driver_type
Enumerator
BORDOISILA_DRIVER_NORMAL 
BORDOISILA_DRIVER_BUS_I2C 
BORDOISILA_DRIVER_BUS_SPI 
BORDOISILA_DRIVER_BUS_USB 

Function Documentation

◆ BordoisilaDriverProbe()

AU_EXTERN AU_EXPORT int BordoisilaDriverProbe ( BordoisilaDriver *  driver)

◆ BordoisilaDriverProbeAll()

void BordoisilaDriverProbeAll ( )
extern

BordoisilaDriverProbeAll – start probing all driver registered.

◆ BordoisilaDriverRegister()

AU_EXTERN AU_EXPORT int BordoisilaDriverRegister ( BordoisilaDriver *  driver)

BordoisilaDriverRegister – register a driver to core registry.

check for pre-registered driver with same compat string

◆ BordoisilaDriverRemove()

AU_EXTERN AU_EXPORT int BordoisilaDriverRemove ( BordoisilaDriver *  driver)

BordoisilaDriverRemove – remove a driver doesn't mean it could be removed from memory, calling remove cleans up driver's allocated resources, and decreaments internal reference count of driver resources it was using like (Clk, Regulator, Pin etc), also if the driver is shared between different module, before calling remove just decrement reference count.

◆ BordoisilaDriverResume()

AU_EXTERN AU_EXPORT int BordoisilaDriverResume ( BordoisilaDriver *  driver)

◆ BordoisilaDriverScan()

AU_EXTERN AU_EXPORT int BordoisilaDriverScan ( BordoisilaDriver *  driver)

BordoisilaDriverScan – scan a bus, only applicable if the driver is a bus.

Parameters
driver– pointer to driver

Interface

Parameters
driver– pointer to driver

◆ BordoisilaDriverSuspend()

AU_EXTERN AU_EXPORT int BordoisilaDriverSuspend ( BordoisilaDriver *  driver)

◆ BordoisilaGetDriverByCompat()

AU_EXTERN AU_EXPORT BordoisilaDriver * BordoisilaGetDriverByCompat ( char *  compat)

BordoisilaGetDriverByCompat – match a driver by its compat string.

Parameters
compat– compatibility string, matches to DT/ACPI bindings

◆ BordoisilaGetDriverByName()

AU_EXTERN AU_EXPORT BordoisilaDriver * BordoisilaGetDriverByName ( char *  name)

BordoisilaGetDriverByName – match a driver by its name.

Parameters
name- name of the driver
Generated by doxygen 1.9.8