1ae5ede03SLoGin use alloc::sync::Arc; 20663027bSTingHuang 3ae5ede03SLoGin use crate::{kerror, syscall::SystemError}; 4ae5ede03SLoGin 5ae5ede03SLoGin use super::{ 6*06d5e247SLoGin device::{device_manager, mkdev, Device, DeviceNumber, IdTable, CHARDEVS, DEVMAP}, 7ae5ede03SLoGin map::{ 8ae5ede03SLoGin kobj_map, kobj_unmap, DeviceStruct, DEV_MAJOR_DYN_END, DEV_MAJOR_DYN_EXT_END, 9ae5ede03SLoGin DEV_MAJOR_DYN_EXT_START, DEV_MAJOR_HASH_SIZE, DEV_MAJOR_MAX, MINOR_MASK, 10ae5ede03SLoGin }, 11ae5ede03SLoGin }; 120663027bSTingHuang 13b087521eSChiichen pub trait CharDevice: Device { 14b087521eSChiichen /// Notice buffer对应设备按字节划分,使用u8类型 15b087521eSChiichen /// Notice offset应该从0开始计数 160663027bSTingHuang 17b087521eSChiichen /// @brief: 从设备的第offset个字节开始,读取len个byte,存放到buf中 18b087521eSChiichen /// @parameter offset: 起始字节偏移量 19b087521eSChiichen /// @parameter len: 读取字节的数量 20b087521eSChiichen /// @parameter buf: 目标数组 21b087521eSChiichen /// @return: 如果操作成功,返回操作的长度(单位是字节);否则返回错误码;如果操作异常,但是并没有检查出什么错误,将返回已操作的长度 22b087521eSChiichen fn read(&self, len: usize, buf: &mut [u8]) -> Result<usize, SystemError>; 230663027bSTingHuang 24b087521eSChiichen /// @brief: 从设备的第offset个字节开始,把buf数组的len个byte,写入到设备中 25b087521eSChiichen /// @parameter offset: 起始字节偏移量 26b087521eSChiichen /// @parameter len: 读取字节的数量 27b087521eSChiichen /// @parameter buf: 目标数组 28b087521eSChiichen /// @return: 如果操作成功,返回操作的长度(单位是字节);否则返回错误码;如果操作异常,但是并没有检查出什么错误,将返回已操作的长度 29b087521eSChiichen fn write(&self, len: usize, buf: &[u8]) -> Result<usize, SystemError>; 300663027bSTingHuang 31b087521eSChiichen /// @brief: 同步信息,把所有的dirty数据写回设备 - 待实现 32b087521eSChiichen fn sync(&self) -> Result<(), SystemError>; 330663027bSTingHuang } 34ae5ede03SLoGin 35ae5ede03SLoGin /// @brief 字符设备框架函数集 36ae5ede03SLoGin pub struct CharDevOps; 37ae5ede03SLoGin 38ae5ede03SLoGin impl CharDevOps { 39ae5ede03SLoGin /// @brief: 主设备号转下标 40ae5ede03SLoGin /// @parameter: major: 主设备号 41ae5ede03SLoGin /// @return: 返回下标 42ae5ede03SLoGin #[allow(dead_code)] 43ae5ede03SLoGin fn major_to_index(major: usize) -> usize { 44ae5ede03SLoGin return major % DEV_MAJOR_HASH_SIZE; 45ae5ede03SLoGin } 46ae5ede03SLoGin 47ae5ede03SLoGin /// @brief: 动态获取主设备号 48ae5ede03SLoGin /// @parameter: None 49ae5ede03SLoGin /// @return: 如果成功,返回主设备号,否则,返回错误码 50ae5ede03SLoGin #[allow(dead_code)] 51ae5ede03SLoGin fn find_dynamic_major() -> Result<usize, SystemError> { 52ae5ede03SLoGin let chardevs = CHARDEVS.lock(); 53ae5ede03SLoGin // 寻找主设备号为234~255的设备 54ae5ede03SLoGin for index in (DEV_MAJOR_DYN_END..DEV_MAJOR_HASH_SIZE).rev() { 55ae5ede03SLoGin if let Some(item) = chardevs.get(index) { 56ae5ede03SLoGin if item.is_empty() { 57ae5ede03SLoGin return Ok(index); // 返回可用的主设备号 58ae5ede03SLoGin } 59ae5ede03SLoGin } 60ae5ede03SLoGin } 61ae5ede03SLoGin // 寻找主设备号在384~511的设备 62ae5ede03SLoGin for index in (DEV_MAJOR_DYN_EXT_END + 1..DEV_MAJOR_DYN_EXT_START + 1).rev() { 63ae5ede03SLoGin if let Some(chardevss) = chardevs.get(Self::major_to_index(index)) { 64ae5ede03SLoGin let mut flag = true; 65ae5ede03SLoGin for item in chardevss { 66ae5ede03SLoGin if item.device_number().major() == index { 67ae5ede03SLoGin flag = false; 68ae5ede03SLoGin break; 69ae5ede03SLoGin } 70ae5ede03SLoGin } 71ae5ede03SLoGin if flag { 72ae5ede03SLoGin // 如果数组中不存在主设备号等于index的设备 73ae5ede03SLoGin return Ok(index); // 返回可用的主设备号 74ae5ede03SLoGin } 75ae5ede03SLoGin } 76ae5ede03SLoGin } 77ae5ede03SLoGin return Err(SystemError::EBUSY); 78ae5ede03SLoGin } 79ae5ede03SLoGin 80ae5ede03SLoGin /// @brief: 注册设备号,该函数需要指定主设备号 81ae5ede03SLoGin /// @parameter: from: 主设备号 82ae5ede03SLoGin /// count: 次设备号数量 83ae5ede03SLoGin /// name: 字符设备名 84ae5ede03SLoGin /// @return: 如果注册成功,返回设备号,否则,返回错误码 85ae5ede03SLoGin #[allow(dead_code)] 86ae5ede03SLoGin pub fn register_chardev_region( 87ae5ede03SLoGin from: DeviceNumber, 88ae5ede03SLoGin count: usize, 89ae5ede03SLoGin name: &'static str, 90ae5ede03SLoGin ) -> Result<DeviceNumber, SystemError> { 91ae5ede03SLoGin Self::__register_chardev_region(from, count, name) 92ae5ede03SLoGin } 93ae5ede03SLoGin 94ae5ede03SLoGin /// @brief: 注册设备号,该函数自动分配主设备号 95ae5ede03SLoGin /// @parameter: baseminor: 次设备号 96ae5ede03SLoGin /// count: 次设备号数量 97ae5ede03SLoGin /// name: 字符设备名 98ae5ede03SLoGin /// @return: 如果注册成功,返回,否则,返回false 99ae5ede03SLoGin #[allow(dead_code)] 100ae5ede03SLoGin pub fn alloc_chardev_region( 101ae5ede03SLoGin baseminor: usize, 102ae5ede03SLoGin count: usize, 103ae5ede03SLoGin name: &'static str, 104ae5ede03SLoGin ) -> Result<DeviceNumber, SystemError> { 105ae5ede03SLoGin Self::__register_chardev_region(mkdev(0, baseminor), count, name) 106ae5ede03SLoGin } 107ae5ede03SLoGin 108ae5ede03SLoGin /// @brief: 注册设备号 109ae5ede03SLoGin /// @parameter: device_number: 设备号,主设备号如果为0,则动态分配 110ae5ede03SLoGin /// minorct: 次设备号数量 111ae5ede03SLoGin /// name: 字符设备名 112ae5ede03SLoGin /// @return: 如果注册成功,返回设备号,否则,返回错误码 113ae5ede03SLoGin fn __register_chardev_region( 114ae5ede03SLoGin device_number: DeviceNumber, 115ae5ede03SLoGin minorct: usize, 116ae5ede03SLoGin name: &'static str, 117ae5ede03SLoGin ) -> Result<DeviceNumber, SystemError> { 118ae5ede03SLoGin let mut major = device_number.major(); 119ae5ede03SLoGin let baseminor = device_number.minor(); 120ae5ede03SLoGin if major >= DEV_MAJOR_MAX { 121ae5ede03SLoGin kerror!( 122ae5ede03SLoGin "DEV {} major requested {} is greater than the maximum {}\n", 123ae5ede03SLoGin name, 124ae5ede03SLoGin major, 125ae5ede03SLoGin DEV_MAJOR_MAX - 1 126ae5ede03SLoGin ); 127ae5ede03SLoGin } 128ae5ede03SLoGin if minorct > MINOR_MASK + 1 - baseminor { 129ae5ede03SLoGin kerror!("DEV {} minor range requested ({}-{}) is out of range of maximum range ({}-{}) for a single major\n", 130ae5ede03SLoGin name, baseminor, baseminor + minorct - 1, 0, MINOR_MASK); 131ae5ede03SLoGin } 132ae5ede03SLoGin let chardev = DeviceStruct::new(mkdev(major, baseminor), minorct, name); 133ae5ede03SLoGin if major == 0 { 134ae5ede03SLoGin // 如果主设备号为0,则自动分配主设备号 135ae5ede03SLoGin major = Self::find_dynamic_major().expect("Find synamic major error.\n"); 136ae5ede03SLoGin } 137ae5ede03SLoGin if let Some(items) = CHARDEVS.lock().get_mut(Self::major_to_index(major)) { 138ae5ede03SLoGin let mut insert_index: usize = 0; 139ae5ede03SLoGin for (index, item) in items.iter().enumerate() { 140ae5ede03SLoGin insert_index = index; 141ae5ede03SLoGin match item.device_number().major().cmp(&major) { 142ae5ede03SLoGin core::cmp::Ordering::Less => continue, 143ae5ede03SLoGin core::cmp::Ordering::Greater => { 144ae5ede03SLoGin break; // 大于则向后插入 145ae5ede03SLoGin } 146ae5ede03SLoGin core::cmp::Ordering::Equal => { 147ae5ede03SLoGin if item.device_number().minor() + item.minorct() <= baseminor { 148ae5ede03SLoGin continue; // 下一个主设备号大于或者次设备号大于被插入的次设备号最大值 149ae5ede03SLoGin } 150ae5ede03SLoGin if item.base_minor() >= baseminor + minorct { 151ae5ede03SLoGin break; // 在此处插入 152ae5ede03SLoGin } 153ae5ede03SLoGin return Err(SystemError::EBUSY); // 存在重合的次设备号 154ae5ede03SLoGin } 155ae5ede03SLoGin } 156ae5ede03SLoGin } 157ae5ede03SLoGin items.insert(insert_index, chardev); 158ae5ede03SLoGin } 159ae5ede03SLoGin return Ok(mkdev(major, baseminor)); 160ae5ede03SLoGin } 161ae5ede03SLoGin 162ae5ede03SLoGin /// @brief: 注销设备号 163ae5ede03SLoGin /// @parameter: major: 主设备号,如果为0,动态分配 164ae5ede03SLoGin /// baseminor: 起始次设备号 165ae5ede03SLoGin /// minorct: 次设备号数量 166ae5ede03SLoGin /// @return: 如果注销成功,返回(),否则,返回错误码 167ae5ede03SLoGin fn __unregister_chardev_region( 168ae5ede03SLoGin device_number: DeviceNumber, 169ae5ede03SLoGin minorct: usize, 170ae5ede03SLoGin ) -> Result<(), SystemError> { 171ae5ede03SLoGin if let Some(items) = CHARDEVS 172ae5ede03SLoGin .lock() 173ae5ede03SLoGin .get_mut(Self::major_to_index(device_number.major())) 174ae5ede03SLoGin { 175ae5ede03SLoGin for (index, item) in items.iter().enumerate() { 176ae5ede03SLoGin if item.device_number() == device_number && item.minorct() == minorct { 177ae5ede03SLoGin // 设备号和数量都相等 178ae5ede03SLoGin items.remove(index); 179ae5ede03SLoGin return Ok(()); 180ae5ede03SLoGin } 181ae5ede03SLoGin } 182ae5ede03SLoGin } 183ae5ede03SLoGin return Err(SystemError::EBUSY); 184ae5ede03SLoGin } 185ae5ede03SLoGin 186ae5ede03SLoGin /// @brief: 字符设备注册 187ae5ede03SLoGin /// @parameter: cdev: 字符设备实例 188ae5ede03SLoGin /// dev_t: 字符设备号 189ae5ede03SLoGin /// range: 次设备号范围 190ae5ede03SLoGin /// @return: none 191ae5ede03SLoGin #[allow(dead_code)] 192*06d5e247SLoGin pub fn cdev_add( 193*06d5e247SLoGin cdev: Arc<dyn CharDevice>, 194*06d5e247SLoGin id_table: IdTable, 195*06d5e247SLoGin range: usize, 196*06d5e247SLoGin ) -> Result<(), SystemError> { 197ae5ede03SLoGin if Into::<usize>::into(id_table.device_number()) == 0 { 198ae5ede03SLoGin kerror!("Device number can't be 0!\n"); 199ae5ede03SLoGin } 200*06d5e247SLoGin device_manager().add_device(cdev.clone())?; 201ae5ede03SLoGin kobj_map( 202ae5ede03SLoGin DEVMAP.clone(), 203ae5ede03SLoGin id_table.device_number(), 204ae5ede03SLoGin range, 205ae5ede03SLoGin cdev.clone(), 206*06d5e247SLoGin ); 207*06d5e247SLoGin 208*06d5e247SLoGin return Ok(()); 209ae5ede03SLoGin } 210ae5ede03SLoGin 211ae5ede03SLoGin /// @brief: 字符设备注销 212ae5ede03SLoGin /// @parameter: dev_t: 字符设备号 213ae5ede03SLoGin /// range: 次设备号范围 214ae5ede03SLoGin /// @return: none 215ae5ede03SLoGin #[allow(dead_code)] 216ae5ede03SLoGin pub fn cdev_del(id_table: IdTable, range: usize) { 217*06d5e247SLoGin device_manager().remove_device(&id_table); 218ae5ede03SLoGin kobj_unmap(DEVMAP.clone(), id_table.device_number(), range); 219ae5ede03SLoGin } 220ae5ede03SLoGin } 221