# klite

**Repository Path**: akdz_admin/klite

## Basic Information

- **Project Name**: klite
- **Description**: 可能是史上最简洁易用的嵌入式操作系统内核!交流QQ群:317930646
- **Primary Language**: C
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 145
- **Created**: 2017-11-03
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

KLite说明文档
=====================
KLite是免费开源软件,基于 MIT 协议开放源代码.
作者: 蒋晓岗\<kerndev@foxmail.com> 保留所有权利.

# 一.简介
	KLite是一个基于ARM Cortex-M微控制器设计的抢占式操作系统内核,设计思想是“简洁易用”.  
	它最大的特点在于简洁易用,可能是目前最简单易用的嵌入式操作系统内核.  
	简洁的API风格,简洁的调用方式,简单的移植方法,大大降低学习和使用的难度.  
	--支持256级优先级抢占  
	--支持创建相同优先级的线程  
	--支持动态内存管理  
	--支持多编译器GCC, IAR, MDK

# 二.移植
	KLite已经为Cortex-M0/M3/M4架构做好了底层适配,如果你的CPU平台是基于以上平台的,
	如STM32F0/1/2/3/4系列单片机,那么可以直接使用预编译的库文件进行开发,  
	否则需要参考源代码自行移植CPU底层的汇编代码.
	参考例程: 
	http://git.oschina.net/kerndev/klite-demo
	https://github.com/Jiangxiaogang/klite-demo

# 三.开始使用
## 1.编译KLite
	在build目录下面有预设的工程文件,选择你要使用的编译器和目标CPU平台,  
	编译完成后,会生成kernel.lib文件,将kernel.lib, kernel.h, port.c复制到你的项目源码中,
	使用lib文件可以减少重复编译时间.

## 2.修改port.c
	根据目标CPU的编程手册,实现port.c里面的3个空函数.
	void cpu_os_init(void)
		这个函数被kernel_init调用,为用户提供一个接口,用于实现那些必须在系统初始化之前的准备工作,
		例如初始化CPU的时钟, 设置FLASH等.
		
	void cpu_os_start(void)
		这个函数被kernel_start调用,为用户提供一个接口,用于实现那些必须在系统初始化之后,系统启动之前的准备工作,
		例如初始化滴答定时器,设置系统中断等.
		
	void cpu_os_idle(void)
		这个函数被空闲线程调用,为用户提供一个接口,用于实现那些在系统空闲时需要完成的工作,
		大多数情况下这个函数什么也不用做.

## 3.在main函数里面添加初始化代码
	main函数的推荐写法如下:
```
void init(void* arg)
{
	bsp_init();
	app_init();
}

void main(void)
{
	kernel_init(RAM_ADDR, RAM_SIZE);
	kthread_create(init, 0, 0);
	kernel_start();
}
```
	说明:
	kernel_init 用于初始化KLite,并设置可用内存;  
	kthread_create 创建第一个主线程init;  
	kernel_start 用于启动KLite;  
	init是一个线程函数,在该函数中实现你的其它初始化代码.  
	相关函数参数说明请参照API文档.  

# 四.支持
	如果你在使用中发现任何BUG或者改进建议,请加入我的QQ群(317930646)或发送邮件至kerndev@foxmail.com.