Drivers

Motoristas

Repositório centralizado para os drivers de baixo nível desenvolvidos pela Zenith Aerospace

Objetivo • Ambiente • Como usar um driver • Adicionando um driver

Objetivo

Armazene e gerencie drivers desenvolvidos.

Como usar um motorista

Cada motorista é organizado em sua própria pasta, onde você encontrará o par .c/.h . Basta adicionar os arquivos ao seu projeto, por exemplo, em um projeto STM32Cubeide, adicione o arquivo .c à pasta Core/Src e ao .h ao Core/Inc . No entanto, todos os drivers usam a platform "Framework", portanto, você também precisa copiar toda a pasta platform para o seu projeto, no STM32Cubeide, adicione -o à pasta Core/Inc . Todos os motoristas devem ter um exemplo de como usá -lo.

Plataforma

A estrutura da plataforma é um conjunto de macros e bibliotecas somente de cabeçalho que os motoristas usam em vez de funções específicas da plataforma. Por exemplo, uma transação I2C em um projeto STM32 chama a biblioteca ST HAL, isso significa que o driver (como é) só pode ser usado nos microcontroladores STM32. O trabalho da plataforma é detectar no qual o microcontrolador está sendo compilado e depois escolher a biblioteca apropriada, para que um driver desenvolvido para a plataforma possa ser usado em outros microcontroladores/processadores.

Como funciona?

Primeiro, o arquivo platform.h configura a interface comum para o driver, structs comuns e assinaturas de funções. Em seguida, um monte de diretivas de pré-processador tentam adivinhar que tipo de projeto esse é e inclui a implementação correta da plataforma (biblioteca somente cabeçalho) na pasta arch .

Para sua informação, se a plataforma não conseguir encontrar uma implementação, o padrão é o modo de depuração de PC, onde é usada uma implementação que apenas imprime o stdout.

Ambiente

Realisticamente, usamos principalmente o STM32Cubeide, pois a maioria dos projetos que realizamos é baseada nessa plataforma. Mas com a estrutura da plataforma, você deve apenas precisar de um compilador C.

Adicionando um motorista

Diretrizes para motoristas:

• Você deve usar C, a menos que seja necessário de outra forma
  • Por que: para maximizar a compatibilidade (sim, ainda existem UCs que só podem usar C)
• Você deve adicionar alguma documentação com um exemplo
  • Por que: a maioria dos usuários só deseja copiar e colar o código correto
• Você deve usar as funções da plataforma para acessar recursos de hardware, a menos que seja necessário
  • Por que: maximize a compatibilidade, no entanto, a plataforma não cobre tudo, por enquanto, você pode adicionar um driver específico da plataforma.

Etapas em uma lista:

1. Clone este repositório
2. Crie uma pasta com o nome do driver
3. Adicione o .c e .h
4. Adicione um arquivo README.md à pasta do driver
   1. No ReadMe, adicione o autor, data e finalidade da biblioteca
   2. Adicionar documentação: parâmetros e propósito de cada função
   3. Adicione uma seção de notas para qualquer informação extra do IC
5. (Opcional) Adicione uma pasta chamada Docs
   1. Adicione qualquer documentação externa, incluindo folhas de dados, notas de aplicativos e mapas de registro
6. Se houver um problema do GitHub para o driver, adicione uma mensagem ou feche -o.

---

[email protected]