# ic0001

**Repository Path**: cioo_memory/ic0001

## Basic Information

- **Project Name**: ic0001
- **Description**: IC0001是中国集成电路开源组织(CIOO)的一个非营利性的开源项目，其项目内容为4MB存储容量的NOR FLASH。
- **Primary Language**: Verilog
- **License**: MulanPSL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 7
- **Forks**: 0
- **Created**: 2019-09-27
- **Last Updated**: 2023-07-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 中国集成电路开源组织(CIOO) - 开源项目 - IC0001

## 1 组织介绍

    中国开源组织China IntegrationCircuit Opensource Organization，开源平台组织名为CIOO，是由一群志同道合的IC相关从业
    者创建的非营利性组织。组织创建的目的在于组织成员自身的学习、IC相关知识的分享，也希望能通过这一开源平台，为想进入集成电路设计
    产业的人员提供一个参考、学习以及交流的场所。
### 1.1 如何加入

    1. 联系邮箱
    - [组织](cioo_admin@163.com)
    - [个人](wangboworks@126.com)

    2. 团队主页  

    可以进入https://gitee.com/cioo_xxx进入相应的团队页面进行申请，其中xxx可以是 :    
    - memory    : 负责存储器类型IC设计研发
    - cpu       : 负责CPU/MCU/SOC等处理器类型芯片的设计研发
    - interface : 负责接口类芯片的设计研发
    - ip        : 负责各类IP的设计研发工作
    - ai        : 负责人工智能类芯片的设计研发
    - tools     : 负责组织开源工具的发布、共享


    其中memory已经有立项，其他几个部分属于未来筹备方向

### 1.2 捐助
    组织目前无需您的捐赠。

### 1.3 联系
    组织管理员联系方式 :
    - Email : cioo_admin@163.com
    - Gitee : gitee.com/cioo_admin
## 2 项目介绍

    本项目发起者为CIOO成员离场悲剧，其在本项目中的角色为项目管理以及负责数字验证的UVM平台验证工作。

### 2.1 项目简介

    项目名称为IC0001，其中 :
        - IC  : 代表集成电路
        - 0   : CIOO开源项目系列之NOR FLASH存储器系列
        - 001 : NOR FLASH存储器编号，存储器特性为支持SPI接口的4Mbits的Nor Flash存储器
    本开源项目是一颗NOR FLASH的存储器芯片，其参考Data Sheet来源于GD、Micron以及项目发起人的公司在内的多款产品。IC0001的数
    据通信接口为标准的SPI接口，它支持标准SPI、双线以及四线SPI，其通信速率最高可达416Mbps。

### 2.2 项目声明

    本项目来源自项目发起者在公司做的项目，为了不泄露公司商业机密以及保证职业道德，本项目从项目设计源头的设计说明书进行处理，对项目的关
    键地方避开原公司设计，对这些地方进行修改或者删除，以保证在项目开源后，依旧不对项目发起者原公司的相关项目造成侵权行为。并且，因为我
    们的项目旨在学习，交流IC设计流程以及方法（大部分项目只有前端设计），CIOO不会对其流片，只会在FPGA上实现，因此，这些更改极有可能无
    法在实际项目中进行运作。
    与此同时，本项目的RTL设计者为非了解原始FLASH项目的设计人员，项目发起者只负责设计的验证平台部分，并且我在此保证，RTL设计为全新设
    计，本人并不会在这一过程中向RTL设计人员提供任何公司相关FLASH代码。从这几个方面来说，也完全杜绝了数字设计的重叠性，保证我们开源项
    目的正向设计原则。

## 3 项目准备

    在开始运行此项目之前，为了完整运行、调试、仿真我们的开源项目，你需要保证以下运行环境 :
    - 系统 : Windows XP Later and Linux
    - 软件 :
        - Windows : Office办公套件，包括W/E/P三件套、Visio以及Project
        - Windows : Git、Timing Designer、Atom等代码编辑器、Python3、Tcl、Perl
        - Windows : Xilinx ISE/Vivado开发套件、Modelsim/Questasim仿真软件
        - Linux   : nLint、Formality、DC、VCS、Ncverilog、Verdi、PT、
        - Linux   : Vim、Python3、Tcl、Perl
        - Linux   : 后端软件

## 4 项目使用  

### 4.1 目录架构  

    - doc----------------------------------------------- 用于存放文档的目录
        - Datasheet------------------------------------- 用于存放项目实际数据手册
        - Design---------------------------------------- 用于存放设计相关文档的目录，包括设计说明书、设计架构说明书等
        - Kick Off-------------------------------------- 用于存放立项文件，包括计划、资源等安排的文档
        - Lesson Learnt--------------------------------- 用于存放项目的经验教训文档
        - IPs------------------------------------------- 用于存放IP相关设计文档
        - Misc------------------------------------------ 用于存放杂项
        - Reference------------------------------------- 用于存放参考文档的目录，包括datasheet paper等
        - Reviews--------------------------------------- 用于存放review相关文档
        - Software-------------------------------------- 用于存放软件相关文档
        - Tapeout--------------------------------------- 用于存放Tapeout用文档
        - User------------------------------------------ 用于存放各个开发者自己的文档，各个开发者可自己在此目录下创建自己的子目录
        - Verification---------------------------------- 用于存放验证相关文档，如验证计划、case list等

    - lay----------------------------------------------- Layout工作目录
    - logic--------------------------------------------- 数字逻辑工程师工作目录
        - apr------------------------------------------- 用于存放apr输入以及输出
        - bin------------------------------------------- 脚本存放目录，脚本入口
        - digital--------------------------------------- 数字工作主目录
        - formal---------------------------------------- Formal形式验证目录
        - lint------------------------------------------ Lint Check目录
        - power----------------------------------------- Power分析目录
        - rtl------------------------------------------- RTL代码存放目录，数字设计工程师工作目录
        - sta------------------------------------------- STA静态时序分析目录
        - syn------------------------------------------- DC综合目录
        - verify---------------------------------------- 数字验证工程师工作目录
            - sv---------------------------------------- System测试平台编写工程师工作目录，子目录与UVM相同
            - uvm--------------------------------------- UVM测试平台编写工程师工作目录
                - coverage------------------------------ coverage工作目录
                - flist--------------------------------- 文件列表目录
                - include------------------------------- include文件存放目录
                - log----------------------------------- log存放目录
                - model--------------------------------- 模型文件目录
                - run----------------------------------- 临时目录
                - tb------------------------------------ 主测试平台存放目录
                - tc------------------------------------ case存放目录
                - wave---------------------------------- 波形存放目录
        - fpga------------------------------------------ FPGA工程师工作目录
        - lib------------------------------------------- 数字综合、仿真用lib存放目录
    - sch----------------------------------------------- 模拟电路工程师工作目录
    - tech---------------------------------------------- 工艺文件存放目录

### 4.2 脚本运行

## 5 开发人员

    项目开发人员名单是截止至2019-10-12在repository中参与贡献的成员，具体名单如下（排名不分先后）：
    - 林潮涛 @ Gitee
    - 离场悲剧 @ Gitee
    - 等待添加...

## 6 参与贡献

### 6.1 流程

    1. Fork 本仓库
    2. 新建 Feat_xxx 分支
    3. 提交代码
    4. 新建 Pull Request

### 6.2 特别鸣谢

## 7 授权信息  

    本项目采用木兰宽松许可证MulanPSL 1.0，详情请见本项目根目录下的“LICENSE”文件。

## 8 码云特技  

    1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
    2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com)
    3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
    4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目，是码云综合评定出的优秀开源项目
    5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
    6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)