Skip to content

Commit

Permalink
Documentation preparation for GitHub
Browse files Browse the repository at this point in the history
- Remove all source files from master branch
- Add top-level README for master branch
- Add LICENSE file
- Add CODE_OF_CONDUCT file

We will also need a CONTRIBUTING guide, but this will be added after the
GitHub project space is created.

Signed-off-by: Michael Leonard <[email protected]>
  • Loading branch information
LeonardMH committed Apr 2, 2024
1 parent c3b5b94 commit 6e34b3d
Show file tree
Hide file tree
Showing 109 changed files with 153 additions and 116,386 deletions.
93 changes: 93 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
![](https://raw.githubusercontent.com/TexasInstruments/texasinstruments.github.io/main/documents/TI_document_header.png)

# Scope

This Code of Conduct applies to all community spaces on the Texas Instruments
Organizational page. It further applies when an individual is officially
representing the community in public spaces. Examples of representing our
community include using an official e-mail address, posting via an official
social media account, or acting as an appointed representative at an online or
offline event.

## Version

This is version 1.0 of the Code of Conduct.

# Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We further pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

# Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

# Enforcement

The Texas Instruments Project maintainers have the right and responsibility to
remove, edit, or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct, and will
communicate reasons for moderation decisions when appropriate.

Texas Instruments Project maintainers who do not follow or enforce the Code of
Conduct in good faith may face temporary or permanent repercussions as
determined by other members of the Texas Instruments Oversight Team.

## Enforcement Guidelines

The Project Maintainers will take appropriate action as deemed necessary based
upon a review of the incident. These actions can include:

* Removal of the content in question
* A warning to those involved and a review of how it volated the Code of Conduct
* A temporary ban from the Community
* A permanent ban from the Community

## Reporting a Code of Conduct Issue

The Project Maintainers from Texas Instruments will review and investigate all
complaints, and will respond in a way, as noted in the Enforcement Guidelines
above, that they deem appropriate to the circumstances. All complaints will
be reviewed and investigated promptly and fairly.

They are further obligated to maintain confidentiality with regard to the
reporter of an incident. Further details of specific enforcement policies may
be posted separately.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the Project Maintainers responsible for enforcement at:
**[email protected]**.

# Attribution

This Code of Conduct is adapted from the Contributor Covenant available at:

- Homepage: https://www.contributor-covenant.org
- v2.1: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
29 changes: 29 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Copyright (c) 2024 Texas Instruments Incorporated - http://www.ti.com

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.

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.

Neither the name of Texas Instruments Incorporated 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.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Texas Instruments PMIC Low-Level Drivers (pmic-lld)

PMIC LLD is designed to support the control and configuration of various Texas
Instruments power management ICs (PMICs) in a platform, processor, and OS
agnostic manner.

PMICs supported by this driver are intended for automotive and industrial
applications and this driver is designed in compliance with the ISO 26262
functional safety standard.

Architecturally, PMIC LLD provides a well-defined API that abstracts low-level
details of the PMIC, allowing users to configure and control device features
without the need to worry about register and bit-field level details.

## Device Support Branches

Device support is subdivided based on feature set:

| Part Number | Friendly Name | Support Branch |
| ----------- | ------------- | ------------------------ |
| TPS6594x | Leo | `device/leo-hera-burton` |
| LP8764x | Hera | `device/leo-hera-burton` |
| TPS6522x | Burton | `device/leo-hera-burton` |
| TPS653860xx | Blackbird | `device/blackbird` |

## Contributing

Contributions are accepted through GitHub pull requests, Texas Instruments
reserves the right to modify or reject contributions for any reason.

See CODE_OF_CONDUCT.md and CONTRIBUTING.md for more information.
310 changes: 0 additions & 310 deletions docs/PMIC-LLD_Manifest.html

This file was deleted.

Binary file not shown.
Loading

0 comments on commit 6e34b3d

Please sign in to comment.